Jump to

• Request
• Response

Create a subscription team member

post

/crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/subscriptionTeam

Request

Path Parameters

• SubscriptionNumber(required): string
  The alternate identifier of the subscription.

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AccessLevel: string
  Maximum Length: 302

  The access level of the contact.
• BillingOwnerFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether this contact is a billing owner or not.
• ContactEmail: string
  Title: Email

  The email address of the contact.
• ContactId(required): integer (int64)
  The unique identifier of the contact.
• ContactName: string
  Title: Name

  The contact name.
• ContactNumber: string
  Title: Party Contact Number

  The number of the subscription contact.
• ContactPuid(required): string
  Maximum Length: 120

  The PUID of the subscription contact.
• ContactRole(required): string
  Title: Role

  Maximum Length: 30

  The contact role of the subscription contact.
• EndDate: string (date)
  The end date of the contact.
• InternalFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether this contact is internal or not.
• OwnerFlag: boolean
  Title: Owner

  Maximum Length: 1

  Default Value: false

  Indicates whether the contact is the owner.
• PartyId: integer
  The unique identifier of the party.
• PartyNumber: string
  Title: Party Number

  Maximum Length: 120

  The number of the party to which the contact belongs.
• PartyPuid: string
  Title: Party Number

  Maximum Length: 120

  The party PUID of the contact.
• PartyRole: string
  Title: Role

  Maximum Length: 20

  The party role of the contact.
• smartActions: array Subscription User Actions
  Title: Subscription User Actions

  The smart actions resource stores the endpoint and security details for every user action.
• StartDate: string (date)
  The start date of the contact.
• SubscriptionContactId: integer (int64)
  The unique identifier of the subscription contact.
• SubscriptionId(required): integer (int64)
  The unique identifier of the subscription.
• SubscriptionNumber: string
  Title: Subscription Number

  Maximum Length: 120

  The subscription number to which the contact belongs.
• SubscriptionPartyId(required): integer (int64)
  The unique identifier of the subscription party.

{
    "required":[
        "ContactId",
        "ContactPuid",
        "ContactRole",
        "SubscriptionId",
        "SubscriptionPartyId"
    ],
    "type":"object",
    "properties":{
        "PartyRole":{
            "title":"Role",
            "maxLength":20,
            "type":"string",
            "description":"The party role of the contact.",
            "nullable":true,
            "x-queryable":false
        },
        "SubscriptionNumber":{
            "title":"Subscription Number",
            "maxLength":120,
            "type":"string",
            "description":"The subscription number to which the contact belongs.",
            "nullable":true,
            "x-queryable":false
        },
        "OwnerFlag":{
            "title":"Owner",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the contact is the owner.",
            "nullable":true,
            "default":false
        },
        "InternalFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether this contact is internal or not.",
            "nullable":true,
            "default":false
        },
        "SubscriptionPartyId":{
            "type":"integer",
            "description":"The unique identifier of the subscription party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ContactId":{
            "type":"integer",
            "description":"The unique identifier of the contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "EndDate":{
            "type":"string",
            "description":"The end date of the contact.",
            "format":"date",
            "nullable":true
        },
        "ContactRole":{
            "title":"Role",
            "maxLength":30,
            "type":"string",
            "description":"The contact role of the subscription contact.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AccessLevel":{
            "maxLength":302,
            "type":"string",
            "description":"The access level of the contact.",
            "nullable":true
        },
        "smartActions":{
            "title":"Subscription User Actions",
            "type":"array",
            "description":"The smart actions resource stores the endpoint and security details for every user action.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-subscriptionTeam-smartActions-item-post-request"
            }
        },
        "StartDate":{
            "type":"string",
            "description":"The start date of the contact.",
            "format":"date",
            "nullable":true
        },
        "PartyNumber":{
            "title":"Party Number",
            "maxLength":120,
            "type":"string",
            "description":"The number of the party to which the contact belongs.",
            "nullable":true,
            "x-queryable":false
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the party.",
            "nullable":true,
            "x-queryable":false
        },
        "ContactPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The PUID of the subscription contact.",
            "nullable":false
        },
        "ContactEmail":{
            "title":"Email",
            "type":"string",
            "description":"The email address of the contact.",
            "nullable":true
        },
        "ContactNumber":{
            "title":"Party Contact Number",
            "type":"string",
            "description":"The number of the subscription contact.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "sortable":false
            }
        },
        "PartyPuid":{
            "title":"Party Number",
            "maxLength":120,
            "type":"string",
            "description":"The party PUID of the contact.",
            "nullable":true
        },
        "BillingOwnerFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether this contact is a billing owner or not.",
            "nullable":true,
            "default":false
        },
        "ContactName":{
            "title":"Name",
            "type":"string",
            "description":"The contact name.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "SubscriptionContactId":{
            "type":"integer",
            "description":"The unique identifier of the subscription contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Nested Schema : Subscription User Actions

Type: array

Title: Subscription User Actions

The smart actions resource stores the endpoint and security details for every user action.

Show Source

• Array of: object subscriptions-subscriptionTeam-smartActions-item-post-request

{
    "title":"Subscription User Actions",
    "type":"array",
    "description":"The smart actions resource stores the endpoint and security details for every user action.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-subscriptionTeam-smartActions-item-post-request"
    }
}

Nested Schema : subscriptions-subscriptionTeam-smartActions-item-post-request

Type: object

Show Source

• ActionIntent: string (byte)
  Title: Action Intent

  The JSON object that describes what an action does and what context data can be passed to the action.
• ConfirmationMessage: string
  Title: Confirmation Message

  Maximum Length: 4000

  A message seeking confirmation for the action being performed.
• ContentType: string
  Title: Content Type

  Maximum Length: 50

  The content type used when invoking the REST endpoint.
• DisplayLabel(required): string
  Title: Action Name

  Maximum Length: 256

  The display label of the subscription smart actions.
• Entity: string
  Title: Parent Entity

  Maximum Length: 150

  The entity of the subscription smart actions.
• Href: string
  Title: REST Endpoint

  Maximum Length: 1024

  The HREF of the subscription smart actions
• IncludedInApplication: string
  Title: Included in Application

  Maximum Length: 512

  The included in application flag of the subscription smart actions.
• MassActionFlag: boolean
  Title: Mass Action

  Maximum Length: 1

  The mass action flag of the smart action.
• Method: string
  Title: HTTP Method

  Maximum Length: 15

  The method associated with the subscription smart actions.
• ObjectFunctionName: string
  Title: Object Function

  Maximum Length: 64

  The object function name of the smart action.
• PageType: string
  Title: Page Type

  Maximum Length: 256

  The page type of the smart action.
• SmartSuggestFlag: boolean
  Title: Smart Suggest

  Maximum Length: 1

  The smart suggest flag of the smart action.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  The flag indicating if the action is seeded or custom.
• UpdateOfAttributes: string
  Title: Attributes to Update

  Maximum Length: 512

  The update of attributes flag of the subscription smart actions.
• UserActionId: integer (int64)
  Title: User Action ID

  The unique identifier of the subscription user actions.
• UserActionName(required): string
  Title: Action Name

  Maximum Length: 256

  The name of the subscription user actions.
• UserActionNavigation: array Smart Action User Interface Definitions
  Title: Smart Action User Interface Definitions

  UI navigation metadata striped by app usage.
• UserActionRank: integer (int64)
  Title: Priority

  The user rank action of the smart action.
• UserActionRequestPayload: array Smart Action REST Payload Definitions
  Title: Smart Action REST Payload Definitions

  If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
• UserActionURLBinding: array Smart Action User Interface Definitions
  Title: Smart Action User Interface Definitions

  Binding metadata for a variable in the URL.

{
    "required":[
        "DisplayLabel",
        "UserActionName"
    ],
    "type":"object",
    "properties":{
        "SmartSuggestFlag":{
            "title":"Smart Suggest",
            "maxLength":1,
            "type":"boolean",
            "description":"The smart suggest flag of the smart action.",
            "nullable":true
        },
        "Entity":{
            "title":"Parent Entity",
            "maxLength":150,
            "type":"string",
            "description":"The entity of the subscription smart actions.",
            "nullable":true
        },
        "ContentType":{
            "title":"Content Type",
            "maxLength":50,
            "type":"string",
            "description":"The content type used when invoking the REST endpoint.",
            "nullable":true
        },
        "UserActionURLBinding":{
            "title":"Smart Action User Interface Definitions",
            "type":"array",
            "description":"Binding metadata for a variable in the URL.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-subscriptionTeam-smartActions-UserActionURLBinding-item-post-request"
            }
        },
        "MassActionFlag":{
            "title":"Mass Action",
            "maxLength":1,
            "type":"boolean",
            "description":"The mass action flag of the smart action.",
            "nullable":true
        },
        "IncludedInApplication":{
            "title":"Included in Application",
            "maxLength":512,
            "type":"string",
            "description":"The included in application flag of the subscription smart actions.",
            "nullable":true
        },
        "UserActionNavigation":{
            "title":"Smart Action User Interface Definitions",
            "type":"array",
            "description":"UI navigation metadata striped by app usage.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-subscriptionTeam-smartActions-UserActionNavigation-item-post-request"
            }
        },
        "Href":{
            "title":"REST Endpoint",
            "maxLength":1024,
            "type":"string",
            "description":"The HREF of the subscription smart actions",
            "nullable":true
        },
        "Method":{
            "title":"HTTP Method",
            "maxLength":15,
            "type":"string",
            "description":"The method associated with the subscription smart actions.",
            "nullable":true
        },
        "DisplayLabel":{
            "title":"Action Name",
            "maxLength":256,
            "type":"string",
            "description":"The display label of the subscription smart actions.",
            "nullable":false
        },
        "UserActionName":{
            "title":"Action Name",
            "maxLength":256,
            "type":"string",
            "description":"The name of the subscription user actions.",
            "nullable":false
        },
        "UserActionId":{
            "title":"User Action ID",
            "type":"integer",
            "description":"The unique identifier of the subscription user actions.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "UserActionRank":{
            "title":"Priority",
            "type":"integer",
            "description":"The user rank action of the smart action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            }
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"The flag indicating if the action is seeded or custom.",
            "nullable":true
        },
        "ConfirmationMessage":{
            "title":"Confirmation Message",
            "maxLength":4000,
            "type":"string",
            "description":"A message seeking confirmation for the action being performed.",
            "nullable":true
        },
        "UserActionRequestPayload":{
            "title":"Smart Action REST Payload Definitions",
            "type":"array",
            "description":"If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-subscriptionTeam-smartActions-UserActionRequestPayload-item-post-request"
            }
        },
        "UpdateOfAttributes":{
            "title":"Attributes to Update",
            "maxLength":512,
            "type":"string",
            "description":"The update of attributes flag of the subscription smart actions.",
            "nullable":true
        },
        "ActionIntent":{
            "title":"Action Intent",
            "type":"string",
            "description":"The JSON object that describes what an action does and what context data can be passed to the action.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ObjectFunctionName":{
            "title":"Object Function",
            "maxLength":64,
            "type":"string",
            "description":"The object function name of the smart action.",
            "nullable":true
        },
        "PageType":{
            "title":"Page Type",
            "maxLength":256,
            "type":"string",
            "description":"The page type of the smart action.",
            "nullable":true
        }
    }
}

Nested Schema : Smart Action User Interface Definitions

Type: array

Title: Smart Action User Interface Definitions

UI navigation metadata striped by app usage.

Show Source

• Array of: object subscriptions-subscriptionTeam-smartActions-UserActionNavigation-item-post-request

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"UI navigation metadata striped by app usage.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-subscriptionTeam-smartActions-UserActionNavigation-item-post-request"
    }
}

Nested Schema : Smart Action REST Payload Definitions

Type: array

Title: Smart Action REST Payload Definitions

If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.

Show Source

• Array of: object subscriptions-subscriptionTeam-smartActions-UserActionRequestPayload-item-post-request

{
    "title":"Smart Action REST Payload Definitions",
    "type":"array",
    "description":"If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-subscriptionTeam-smartActions-UserActionRequestPayload-item-post-request"
    }
}

Nested Schema : Smart Action User Interface Definitions

Type: array

Title: Smart Action User Interface Definitions

Binding metadata for a variable in the URL.

Show Source

• Array of: object subscriptions-subscriptionTeam-smartActions-UserActionURLBinding-item-post-request

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"Binding metadata for a variable in the URL.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-subscriptionTeam-smartActions-UserActionURLBinding-item-post-request"
    }
}

Nested Schema : subscriptions-subscriptionTeam-smartActions-UserActionNavigation-item-post-request

Type: object

Show Source

• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  The system action flag of the user action navigation.
• UserActionNavAppUsage: string
  Title: Application Usage

  Maximum Length: 50

  The user action navigation application usage.
• UserActionNavBody: string
  Title: Navigation Metadata

  Maximum Length: 1000

  The body of user action navigation.
• UserActionNavId: integer (int64)
  Title: Primary Key

  The unique identifier of the subscription user action navigation.
• UserActionNavType: string
  Title: Navigation Type

  Maximum Length: 100

  The type of user action navigation.

{
    "type":"object",
    "properties":{
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"The system action flag of the user action navigation.",
            "nullable":true,
            "default":false
        },
        "UserActionNavId":{
            "title":"Primary Key",
            "type":"integer",
            "description":"The unique identifier of the subscription user action navigation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "UserActionNavType":{
            "title":"Navigation Type",
            "maxLength":100,
            "type":"string",
            "description":"The type of user action navigation.",
            "nullable":false
        },
        "UserActionNavBody":{
            "title":"Navigation Metadata",
            "maxLength":1000,
            "type":"string",
            "description":"The body of user action navigation.",
            "nullable":true
        },
        "UserActionNavAppUsage":{
            "title":"Application Usage",
            "maxLength":50,
            "type":"string",
            "description":"The user action navigation application usage.",
            "nullable":false
        }
    }
}

Nested Schema : subscriptions-subscriptionTeam-smartActions-UserActionRequestPayload-item-post-request

Type: object

Show Source

• Binding: string
  Title: Payload Value Binding Type

  Maximum Length: 64

  The binding of the user action payload.
• MandatoryFlag: boolean
  Title: Mandatory

  Maximum Length: 1

  The mandatory flag of the user action payload.
• RequestPayloadId: integer (int64)
  The request payload ID of the user action.
• RequestPayloadName: string
  Title: Request Payload Attribute Name

  Maximum Length: 256

  The request payload name of the user action.
• SmartSuggestPath: string
  Title: Smart Suggest Path

  Maximum Length: 2048

  The smart suggest path of the user action payload.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  The system action flag of the user action request payload.
• Value: string
  Title: Request Payload Attribute Value

  Maximum Length: 1000

  The value of the user action payload.
• ValueStruct: string
  Title: Payload Value Structure

  Maximum Length: 20

  The value structure of the user action payload.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"Payload Value Binding Type",
            "maxLength":64,
            "type":"string",
            "description":"The binding of the user action payload.",
            "nullable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"The system action flag of the user action request payload.",
            "nullable":true,
            "default":false
        },
        "ValueStruct":{
            "title":"Payload Value Structure",
            "maxLength":20,
            "type":"string",
            "description":"The value structure of the user action payload.",
            "nullable":true
        },
        "Value":{
            "title":"Request Payload Attribute Value",
            "maxLength":1000,
            "type":"string",
            "description":"The value of the user action payload.",
            "nullable":true
        },
        "SmartSuggestPath":{
            "title":"Smart Suggest Path",
            "maxLength":2048,
            "type":"string",
            "description":"The smart suggest path of the user action payload.",
            "nullable":true
        },
        "RequestPayloadId":{
            "type":"integer",
            "description":"The request payload ID of the user action.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RequestPayloadName":{
            "title":"Request Payload Attribute Name",
            "maxLength":256,
            "type":"string",
            "description":"The request payload name of the user action.",
            "nullable":false
        },
        "MandatoryFlag":{
            "title":"Mandatory",
            "maxLength":1,
            "type":"boolean",
            "description":"The mandatory flag of the user action payload.",
            "nullable":true
        }
    }
}

Nested Schema : subscriptions-subscriptionTeam-smartActions-UserActionURLBinding-item-post-request

Type: object

Show Source

• Binding: string
  Title: URL Binding Type

  Maximum Length: 64

  The URL binding of user action.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  The system action flag of the user action URL binding.
• URLBindingId: integer (int64)
  The identifier of URL binding of user action.
• URLBindingName: string
  Title: URL Binding Parameter Name

  Maximum Length: 256

  The name of URL binding of user action.
• Value: string
  Title: URL Binding Parameter Value

  Maximum Length: 1000

  The value of URL binding of user action.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"URL Binding Type",
            "maxLength":64,
            "type":"string",
            "description":"The URL binding of user action.",
            "nullable":true
        },
        "Value":{
            "title":"URL Binding Parameter Value",
            "maxLength":1000,
            "type":"string",
            "description":"The value of URL binding of user action.",
            "nullable":true
        },
        "URLBindingId":{
            "type":"integer",
            "description":"The identifier of URL binding of user action.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"The system action flag of the user action URL binding.",
            "nullable":true,
            "default":false
        },
        "URLBindingName":{
            "title":"URL Binding Parameter Name",
            "maxLength":256,
            "type":"string",
            "description":"The name of URL binding of user action.",
            "nullable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : subscriptions-subscriptionTeam-item-response

Type: object

Show Source

• AccessLevel: string
  Maximum Length: 302

  The access level of the contact.
• BillingOwnerFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether this contact is a billing owner or not.
• ContactEmail: string
  Title: Email

  The email address of the contact.
• ContactId: integer (int64)
  The unique identifier of the contact.
• ContactName: string
  Title: Name

  The contact name.
• ContactNumber: string
  Title: Party Contact Number

  The number of the subscription contact.
• ContactPuid: string
  Maximum Length: 120

  The PUID of the subscription contact.
• ContactRole: string
  Title: Role

  Maximum Length: 30

  The contact role of the subscription contact.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the contact.
• CreationDate: string (date-time)
  Read Only: true

  The date when the contact was created.
• EndDate: string (date)
  The end date of the contact.
• InternalFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether this contact is internal or not.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the contact was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the contact.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the contact.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  The object version number of the contact.
• OwnerFlag: boolean
  Title: Owner

  Maximum Length: 1

  Default Value: false

  Indicates whether the contact is the owner.
• PartyId: integer
  The unique identifier of the party.
• PartyNumber: string
  Title: Party Number

  Maximum Length: 120

  The number of the party to which the contact belongs.
• PartyPuid: string
  Title: Party Number

  Maximum Length: 120

  The party PUID of the contact.
• PartyRole: string
  Title: Role

  Maximum Length: 20

  The party role of the contact.
• smartActions: array Subscription User Actions
  Title: Subscription User Actions

  The smart actions resource stores the endpoint and security details for every user action.
• StartDate: string (date)
  The start date of the contact.
• SubscriptionContactId: integer (int64)
  The unique identifier of the subscription contact.
• SubscriptionId: integer (int64)
  The unique identifier of the subscription.
• SubscriptionNumber: string
  Title: Subscription Number

  Maximum Length: 120

  The subscription number to which the contact belongs.
• SubscriptionPartyId: integer (int64)
  The unique identifier of the subscription party.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the contact was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubscriptionPartyId":{
            "type":"integer",
            "description":"The unique identifier of the subscription party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContactId":{
            "type":"integer",
            "description":"The unique identifier of the contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContactRole":{
            "title":"Role",
            "maxLength":30,
            "type":"string",
            "description":"The contact role of the subscription contact.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "smartActions":{
            "title":"Subscription User Actions",
            "type":"array",
            "description":"The smart actions resource stores the endpoint and security details for every user action.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-subscriptionTeam-smartActions-item-response"
            }
        },
        "StartDate":{
            "type":"string",
            "description":"The start date of the contact.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number of the contact.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ContactPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The PUID of the subscription contact.",
            "nullable":false,
            "x-queryable":true
        },
        "ContactNumber":{
            "title":"Party Contact Number",
            "type":"string",
            "description":"The number of the subscription contact.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "sortable":false
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyRole":{
            "title":"Role",
            "maxLength":20,
            "type":"string",
            "description":"The party role of the contact.",
            "nullable":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubscriptionNumber":{
            "title":"Subscription Number",
            "maxLength":120,
            "type":"string",
            "description":"The subscription number to which the contact belongs.",
            "nullable":true,
            "x-queryable":false
        },
        "OwnerFlag":{
            "title":"Owner",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the contact is the owner.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "InternalFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether this contact is internal or not.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"The end date of the contact.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AccessLevel":{
            "maxLength":302,
            "type":"string",
            "description":"The access level of the contact.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyNumber":{
            "title":"Party Number",
            "maxLength":120,
            "type":"string",
            "description":"The number of the party to which the contact belongs.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the party.",
            "nullable":true,
            "x-queryable":false
        },
        "ContactEmail":{
            "title":"Email",
            "type":"string",
            "description":"The email address of the contact.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyPuid":{
            "title":"Party Number",
            "maxLength":120,
            "type":"string",
            "description":"The party PUID of the contact.",
            "nullable":true,
            "x-queryable":true
        },
        "BillingOwnerFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether this contact is a billing owner or not.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ContactName":{
            "title":"Name",
            "type":"string",
            "description":"The contact name.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the contact was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubscriptionContactId":{
            "type":"integer",
            "description":"The unique identifier of the subscription contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Subscription User Actions

Type: array

Title: Subscription User Actions

The smart actions resource stores the endpoint and security details for every user action.

Show Source

• Array of: object subscriptions-subscriptionTeam-smartActions-item-response

{
    "title":"Subscription User Actions",
    "type":"array",
    "description":"The smart actions resource stores the endpoint and security details for every user action.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-subscriptionTeam-smartActions-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : subscriptions-subscriptionTeam-smartActions-item-response

Type: object

Show Source

• ActionIntent: string (byte)
  Title: Action Intent

  The JSON object that describes what an action does and what context data can be passed to the action.
• ConfirmationMessage: string
  Title: Confirmation Message

  Maximum Length: 4000

  A message seeking confirmation for the action being performed.
• ContentType: string
  Title: Content Type

  Maximum Length: 50

  The content type used when invoking the REST endpoint.
• DisplayLabel: string
  Title: Action Name

  Maximum Length: 256

  The display label of the subscription smart actions.
• Entity: string
  Title: Parent Entity

  Maximum Length: 150

  The entity of the subscription smart actions.
• Href: string
  Title: REST Endpoint

  Maximum Length: 1024

  The HREF of the subscription smart actions
• IncludedInApplication: string
  Title: Included in Application

  Maximum Length: 512

  The included in application flag of the subscription smart actions.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MassActionFlag: boolean
  Title: Mass Action

  Maximum Length: 1

  The mass action flag of the smart action.
• Method: string
  Title: HTTP Method

  Maximum Length: 15

  The method associated with the subscription smart actions.
• ObjectFunctionName: string
  Title: Object Function

  Maximum Length: 64

  The object function name of the smart action.
• PageType: string
  Title: Page Type

  Maximum Length: 256

  The page type of the smart action.
• SmartSuggestFlag: boolean
  Title: Smart Suggest

  Maximum Length: 1

  The smart suggest flag of the smart action.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  The flag indicating if the action is seeded or custom.
• UpdateOfAttributes: string
  Title: Attributes to Update

  Maximum Length: 512

  The update of attributes flag of the subscription smart actions.
• UserActionId: integer (int64)
  Title: User Action ID

  The unique identifier of the subscription user actions.
• UserActionName: string
  Title: Action Name

  Maximum Length: 256

  The name of the subscription user actions.
• UserActionNavigation: array User Action Navigation
  Title: User Action Navigation

  The user action navigation resource stores the UI navigation metadata striped by app usage.
• UserActionRank: integer (int64)
  Title: Priority

  The user rank action of the smart action.
• UserActionRequestPayload: array User Action Request Payload
  Title: User Action Request Payload

  The user action request payload resource stores the payload information for every user action request.
• UserActionURLBinding: array User Action URL Binding
  Title: User Action URL Binding

  The user action URL binding resource stores the binding metadata for a variable in the URL.

{
    "type":"object",
    "properties":{
        "SmartSuggestFlag":{
            "title":"Smart Suggest",
            "maxLength":1,
            "type":"boolean",
            "description":"The smart suggest flag of the smart action.",
            "nullable":true,
            "x-queryable":true
        },
        "Entity":{
            "title":"Parent Entity",
            "maxLength":150,
            "type":"string",
            "description":"The entity of the subscription smart actions.",
            "nullable":true,
            "x-queryable":true
        },
        "ContentType":{
            "title":"Content Type",
            "maxLength":50,
            "type":"string",
            "description":"The content type used when invoking the REST endpoint.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionURLBinding":{
            "title":"User Action URL Binding",
            "type":"array",
            "description":"The user action URL binding resource stores the binding metadata for a variable in the URL.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-subscriptionTeam-smartActions-UserActionURLBinding-item-response"
            }
        },
        "MassActionFlag":{
            "title":"Mass Action",
            "maxLength":1,
            "type":"boolean",
            "description":"The mass action flag of the smart action.",
            "nullable":true,
            "x-queryable":true
        },
        "IncludedInApplication":{
            "title":"Included in Application",
            "maxLength":512,
            "type":"string",
            "description":"The included in application flag of the subscription smart actions.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionNavigation":{
            "title":"User Action Navigation",
            "type":"array",
            "description":"The user action navigation resource stores the UI navigation metadata striped by app usage.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-subscriptionTeam-smartActions-UserActionNavigation-item-response"
            }
        },
        "Href":{
            "title":"REST Endpoint",
            "maxLength":1024,
            "type":"string",
            "description":"The HREF of the subscription smart actions",
            "nullable":true,
            "x-queryable":true
        },
        "Method":{
            "title":"HTTP Method",
            "maxLength":15,
            "type":"string",
            "description":"The method associated with the subscription smart actions.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplayLabel":{
            "title":"Action Name",
            "maxLength":256,
            "type":"string",
            "description":"The display label of the subscription smart actions.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionName":{
            "title":"Action Name",
            "maxLength":256,
            "type":"string",
            "description":"The name of the subscription user actions.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionId":{
            "title":"User Action ID",
            "type":"integer",
            "description":"The unique identifier of the subscription user actions.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UserActionRank":{
            "title":"Priority",
            "type":"integer",
            "description":"The user rank action of the smart action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            },
            "x-queryable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"The flag indicating if the action is seeded or custom.",
            "nullable":true,
            "x-queryable":true
        },
        "ConfirmationMessage":{
            "title":"Confirmation Message",
            "maxLength":4000,
            "type":"string",
            "description":"A message seeking confirmation for the action being performed.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionRequestPayload":{
            "title":"User Action Request Payload",
            "type":"array",
            "description":"The user action request payload resource stores the payload information for every user action request.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-subscriptionTeam-smartActions-UserActionRequestPayload-item-response"
            }
        },
        "UpdateOfAttributes":{
            "title":"Attributes to Update",
            "maxLength":512,
            "type":"string",
            "description":"The update of attributes flag of the subscription smart actions.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionIntent":{
            "title":"Action Intent",
            "type":"string",
            "description":"The JSON object that describes what an action does and what context data can be passed to the action.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ObjectFunctionName":{
            "title":"Object Function",
            "maxLength":64,
            "type":"string",
            "description":"The object function name of the smart action.",
            "nullable":true,
            "x-queryable":true
        },
        "PageType":{
            "title":"Page Type",
            "maxLength":256,
            "type":"string",
            "description":"The page type of the smart action.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : User Action Navigation

Type: array

Title: User Action Navigation

The user action navigation resource stores the UI navigation metadata striped by app usage.

Show Source

• Array of: object subscriptions-subscriptionTeam-smartActions-UserActionNavigation-item-response

{
    "title":"User Action Navigation",
    "type":"array",
    "description":"The user action navigation resource stores the UI navigation metadata striped by app usage.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-subscriptionTeam-smartActions-UserActionNavigation-item-response"
    }
}

Nested Schema : User Action Request Payload

Type: array

Title: User Action Request Payload

The user action request payload resource stores the payload information for every user action request.

Show Source

• Array of: object subscriptions-subscriptionTeam-smartActions-UserActionRequestPayload-item-response

{
    "title":"User Action Request Payload",
    "type":"array",
    "description":"The user action request payload resource stores the payload information for every user action request.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-subscriptionTeam-smartActions-UserActionRequestPayload-item-response"
    }
}

Nested Schema : User Action URL Binding

Type: array

Title: User Action URL Binding

The user action URL binding resource stores the binding metadata for a variable in the URL.

Show Source

• Array of: object subscriptions-subscriptionTeam-smartActions-UserActionURLBinding-item-response

{
    "title":"User Action URL Binding",
    "type":"array",
    "description":"The user action URL binding resource stores the binding metadata for a variable in the URL.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-subscriptionTeam-smartActions-UserActionURLBinding-item-response"
    }
}

Nested Schema : subscriptions-subscriptionTeam-smartActions-UserActionNavigation-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  The system action flag of the user action navigation.
• UserActionNavAppUsage: string
  Title: Application Usage

  Maximum Length: 50

  The user action navigation application usage.
• UserActionNavBody: string
  Title: Navigation Metadata

  Maximum Length: 1000

  The body of user action navigation.
• UserActionNavId: integer (int64)
  Title: Primary Key

  The unique identifier of the subscription user action navigation.
• UserActionNavType: string
  Title: Navigation Type

  Maximum Length: 100

  The type of user action navigation.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"The system action flag of the user action navigation.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "UserActionNavId":{
            "title":"Primary Key",
            "type":"integer",
            "description":"The unique identifier of the subscription user action navigation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UserActionNavType":{
            "title":"Navigation Type",
            "maxLength":100,
            "type":"string",
            "description":"The type of user action navigation.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionNavBody":{
            "title":"Navigation Metadata",
            "maxLength":1000,
            "type":"string",
            "description":"The body of user action navigation.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionNavAppUsage":{
            "title":"Application Usage",
            "maxLength":50,
            "type":"string",
            "description":"The user action navigation application usage.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptions-subscriptionTeam-smartActions-UserActionRequestPayload-item-response

Type: object

Show Source

• Binding: string
  Title: Payload Value Binding Type

  Maximum Length: 64

  The binding of the user action payload.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MandatoryFlag: boolean
  Title: Mandatory

  Maximum Length: 1

  The mandatory flag of the user action payload.
• RequestPayloadId: integer (int64)
  The request payload ID of the user action.
• RequestPayloadName: string
  Title: Request Payload Attribute Name

  Maximum Length: 256

  The request payload name of the user action.
• SmartSuggestPath: string
  Title: Smart Suggest Path

  Maximum Length: 2048

  The smart suggest path of the user action payload.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  The system action flag of the user action request payload.
• Value: string
  Title: Request Payload Attribute Value

  Maximum Length: 1000

  The value of the user action payload.
• ValueStruct: string
  Title: Payload Value Structure

  Maximum Length: 20

  The value structure of the user action payload.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"Payload Value Binding Type",
            "maxLength":64,
            "type":"string",
            "description":"The binding of the user action payload.",
            "nullable":true,
            "x-queryable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"The system action flag of the user action request payload.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ValueStruct":{
            "title":"Payload Value Structure",
            "maxLength":20,
            "type":"string",
            "description":"The value structure of the user action payload.",
            "nullable":true,
            "x-queryable":true
        },
        "Value":{
            "title":"Request Payload Attribute Value",
            "maxLength":1000,
            "type":"string",
            "description":"The value of the user action payload.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SmartSuggestPath":{
            "title":"Smart Suggest Path",
            "maxLength":2048,
            "type":"string",
            "description":"The smart suggest path of the user action payload.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestPayloadId":{
            "type":"integer",
            "description":"The request payload ID of the user action.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RequestPayloadName":{
            "title":"Request Payload Attribute Name",
            "maxLength":256,
            "type":"string",
            "description":"The request payload name of the user action.",
            "nullable":false,
            "x-queryable":true
        },
        "MandatoryFlag":{
            "title":"Mandatory",
            "maxLength":1,
            "type":"boolean",
            "description":"The mandatory flag of the user action payload.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptions-subscriptionTeam-smartActions-UserActionURLBinding-item-response

Type: object

Show Source

• Binding: string
  Title: URL Binding Type

  Maximum Length: 64

  The URL binding of user action.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  The system action flag of the user action URL binding.
• URLBindingId: integer (int64)
  The identifier of URL binding of user action.
• URLBindingName: string
  Title: URL Binding Parameter Name

  Maximum Length: 256

  The name of URL binding of user action.
• Value: string
  Title: URL Binding Parameter Value

  Maximum Length: 1000

  The value of URL binding of user action.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"URL Binding Type",
            "maxLength":64,
            "type":"string",
            "description":"The URL binding of user action.",
            "nullable":true,
            "x-queryable":true
        },
        "Value":{
            "title":"URL Binding Parameter Value",
            "maxLength":1000,
            "type":"string",
            "description":"The value of URL binding of user action.",
            "nullable":true,
            "x-queryable":true
        },
        "URLBindingId":{
            "type":"integer",
            "description":"The identifier of URL binding of user action.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"The system action flag of the user action URL binding.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "URLBindingName":{
            "title":"URL Binding Parameter Name",
            "maxLength":256,
            "type":"string",
            "description":"The name of URL binding of user action.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

ContactRolesVA

Operation: /crmRestApi/resources/11.13.18.05/contactRoles

Parameters:

• finder: LookupTypeAndCodeIsEnabledFinder%3BBindLookupType%3DORA_OSS_PARTY_CONTACT_ROLES

The list of values indicating the contact role.

The following properties are defined on the LOV link relation:

• Source Attribute: ContactRole; Target Attribute: LookupCode
• Display Attribute: Meaning

InternalContactsVO

Operation: /crmRestApi/resources/11.13.18.05/internalContacts

Parameters:

• finder: InternalContactsbyPartyIdRowFinder

The following properties are defined on the LOV link relation:

• Source Attribute: ContactName; Target Attribute: ContactName
• Display Attribute: ContactName

smartActions

Operation: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/subscriptionTeam/{SubscriptionContactId}/child/smartActions

Parameters:

• SubscriptionContactId2: $request.path.SubscriptionContactId2
• SubscriptionNumber: $request.path.SubscriptionNumber

The smart actions resource stores the endpoint and security details for every user action.

Back to Top