Jump to

• Request
• Response

Create a collaboration action

post

/crmRestApi/resources/11.13.18.05/collaborationActions

Request

Header Parameters

• 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.
• Upsert-Mode:
  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

• actionAttributes: array Action Attributes
  Title: Action Attributes

  The attributes resource lets you view, create, update, and delete attributes used in a collaboration network. These attributes are sent or received from the collaboration network when an action is performed.
• CatalogCd: string
  Title: REST Catalog

  Maximum Length: 30

  Default Value: crmRestApi

  The REST catalog used to generate the endpoint for the business object.
• ChannelId: integer (int64)
  Title: Channel ID

  The unique identifier of the service channel associated with the collaboration action.
• CollabActionCd: string
  Title: Action Code

  Maximum Length: 30

  A unique code that identifier the collaboration action.
• CollabActionMethod: string
  Title: Action Method

  Maximum Length: 64

  The REST API action invoked by the collaboration action such as GET or POST.
• CollabActionName(required): string
  Title: Action Name

  Maximum Length: 64

  The display name of the collaboration action.
• CollabActionNumber: string
  Title: Action Number

  Maximum Length: 30

  The alternate unique identifier of the collaboration action.
• CollabActionTypeCd: string
  Title: Action Type

  Maximum Length: 30

  Specifies what the collaboration action does when run, such as call an API or show a dialog.
• ControlTypeCd: string
  Title: User Interface Component

  Maximum Length: 30

  The UI controls used to display the action on the collaboration network.
• Description: string
  Title: Description

  Maximum Length: 1000

  The description of the collaboration action.
• DisplaySequence: integer (int64)
  Title: Display Sequence

  The display sequence of the collaboration action. This is primarily applicable to child actions that are displayed on the collaboration network UI.
• ObjectName(required): string
  Title: Business Object

  Maximum Length: 64

  The business object associated with the collaboration action such as service request or opportunity.
• ParentActionId: integer (int64)
  Title: Parent Action ID

  The unique identifier of the parent action for the collaboration action.
• RequestContentType: string
  Title: Request Content Type

  Maximum Length: 64

  The content type of the REST API request payload.
• RequestEndPoint: string
  Title: Request End Point

  Maximum Length: 4000

  The endpoint of the Request API for the collaboration action.
• RequestPayload: string (byte)
  Title: Request Payload

  The request payload for the request API.
• ResponseContentType: string
  Title: Response Content Type

  Maximum Length: 64

  The content type of the REST API response.
• ResponseEntityTypeCd: string
  Title: Response Type

  Maximum Length: 30

  The response type of collaboration actions such as Action Attributes or Payload.
• ResponseMsgTypeCd: string
  Title: Response Visibility

  Maximum Length: 30

  Indicates the visibility of the action response in the collaboration network such as private or public.
• ResponsePayload: string (byte)
  Title: Response Payload

  The response of the collaboration action.
• StatusCd: string
  Title: Status

  Maximum Length: 30

  Default Value: DRAFT

  The status of the collaboration action such as DRAFT or ACTIVE.

{
    "required":[
        "CollabActionName",
        "ObjectName"
    ],
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The description of the collaboration action.",
            "nullable":true
        },
        "CatalogCd":{
            "title":"REST Catalog",
            "maxLength":"30",
            "type":"string",
            "description":"The REST catalog used to generate the endpoint for the business object.",
            "nullable":true,
            "default":"crmRestApi",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CollabActionMethod":{
            "title":"Action Method",
            "maxLength":"64",
            "type":"string",
            "description":"The REST API action invoked by the collaboration action such as GET or POST.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ParentActionId":{
            "title":"Parent Action ID",
            "type":"integer",
            "description":"The unique identifier of the parent action for the collaboration action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The display sequence of the collaboration action. This is primarily applicable to child actions that are displayed on the collaboration network UI.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ResponseMsgTypeCd":{
            "title":"Response Visibility",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the visibility of the action response in the collaboration network such as private or public.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "StatusCd":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the collaboration action such as DRAFT or ACTIVE.",
            "nullable":false,
            "default":"DRAFT",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ResponseContentType":{
            "title":"Response Content Type",
            "maxLength":"64",
            "type":"string",
            "description":"The content type of the REST API response.",
            "nullable":true
        },
        "actionAttributes":{
            "title":"Action Attributes",
            "type":"array",
            "description":"The attributes resource lets you view, create, update, and delete attributes used in a collaboration network. These attributes are sent or received from the collaboration network when an action is performed.",
            "items":{
                "$ref":"#/components/schemas/collaborationActions-actionAttributes-item-post-request"
            }
        },
        "RequestEndPoint":{
            "title":"Request End Point",
            "maxLength":"4000",
            "type":"string",
            "description":"The endpoint of the Request API for the collaboration action.",
            "nullable":true
        },
        "ChannelId":{
            "title":"Channel ID",
            "type":"integer",
            "description":"The unique identifier of the service channel associated with the collaboration action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ResponseEntityTypeCd":{
            "title":"Response Type",
            "maxLength":"30",
            "type":"string",
            "description":"The response type of collaboration actions such as Action Attributes or Payload.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ObjectName":{
            "title":"Business Object",
            "maxLength":"64",
            "type":"string",
            "description":"The business object associated with the collaboration action such as service request or opportunity.",
            "nullable":false
        },
        "ResponsePayload":{
            "title":"Response Payload",
            "type":"string",
            "description":"The response of the collaboration action.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "CollabActionTypeCd":{
            "title":"Action Type",
            "maxLength":"30",
            "type":"string",
            "description":"Specifies what the collaboration action does when run, such as call an API or show a dialog.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CollabActionCd":{
            "title":"Action Code",
            "maxLength":"30",
            "type":"string",
            "description":"A unique code that identifier the collaboration action.",
            "nullable":true
        },
        "ControlTypeCd":{
            "title":"User Interface Component",
            "maxLength":"30",
            "type":"string",
            "description":"The UI controls used to display the action on the collaboration network.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CollabActionNumber":{
            "title":"Action Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate unique identifier of the collaboration action.",
            "nullable":false
        },
        "RequestContentType":{
            "title":"Request Content Type",
            "maxLength":"64",
            "type":"string",
            "description":"The content type of the REST API request payload.",
            "nullable":true
        },
        "CollabActionName":{
            "title":"Action Name",
            "maxLength":"64",
            "type":"string",
            "description":"The display name of the collaboration action.",
            "nullable":false
        },
        "RequestPayload":{
            "title":"Request Payload",
            "type":"string",
            "description":"The request payload for the request API.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Action Attributes

Type: array

Title: Action Attributes

The attributes resource lets you view, create, update, and delete attributes used in a collaboration network. These attributes are sent or received from the collaboration network when an action is performed.

Show Source

• Array of: object schema

{
    "title":"Action Attributes",
    "type":"array",
    "description":"The attributes resource lets you view, create, update, and delete attributes used in a collaboration network. These attributes are sent or received from the collaboration network when an action is performed.",
    "items":{
        "$ref":"#/components/schemas/collaborationActions-actionAttributes-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• AttribName: string
  Title: Attribute Name

  Maximum Length: 64

  The business object attribute name associated with the collaboration action.
• ChannelId: integer (int64)
  Title: Channel ID

  The channel associated with the action attribute.
• CollabActionId: integer (int64)
  Title: Action ID

  The unique identifier of the collaboration action associated with the attribute.
• ContextAttribFlag: boolean
  Title: Business Object Identifier

  Maximum Length: 1

  Default Value: false

  Indicates if the action attribute is used as the context attribute for passing to and from the collaboration network and CX Sales.
• ControlTypeCd: string
  Title: User Interface Component

  Maximum Length: 30

  The UI controls used to display the attributes on the collaboration network such as List or Text box.
• DataSource: string
  Title: End Point

  Maximum Length: 4000

  The API to get the a list of values for an attribute of type list.
• DataSourceLabelAttrib: string
  Title: Option Label

  Maximum Length: 64

  The API attribute used as the display value of the action attribute. This applies to action attributes with control type as List.
• DataSourceValueAttrib: string
  Title: Option Value

  Maximum Length: 64

  The API attribute used to save the selected action attribute value. This applies to action attributes with control type as List.
• DataTypeCd: string
  Title: Data Type

  Maximum Length: 30

  The data type of collaboration action attributes such as Date Time or Number.
• DeepLink: string
  Title: Deep Link

  Maximum Length: 1000

  A deep link URL format that links to the object associated with the action attribute.
• DefaultValue: string
  Title: Default Value

  Maximum Length: 4000

  The default value of the action attribute.
• DisplayName: string
  Title: Display Name

  Maximum Length: 64

  The label of the action attribute displayed when displaying the attribute in the collaboration network.
• DisplaySequence: integer (int64)
  Title: Display Sequence

  The display order of the action attribute.
• RequestAttribFlag: boolean
  Title: Included in Request

  Maximum Length: 1

  Default Value: false

  Indicates if the action attribute is part of the request payload.
• ResponseAttribFlag: boolean
  Title: Included in Response

  Maximum Length: 1

  Default Value: false

  Indicates if the action attribute is part of the response payload.

{
    "type":"object",
    "properties":{
        "DataSourceValueAttrib":{
            "title":"Option Value",
            "maxLength":"64",
            "type":"string",
            "description":"The API attribute used to save the selected action attribute value. This applies to action attributes with control type as List.",
            "nullable":true
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The display order of the action attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "DeepLink":{
            "title":"Deep Link",
            "maxLength":"1000",
            "type":"string",
            "description":"A deep link URL format that links to the object associated with the action attribute.",
            "nullable":true
        },
        "CollabActionId":{
            "title":"Action ID",
            "type":"integer",
            "description":"The unique identifier of the collaboration action associated with the attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "DataTypeCd":{
            "title":"Data Type",
            "maxLength":"30",
            "type":"string",
            "description":"The data type of collaboration action attributes such as Date Time or Number.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ChannelId":{
            "title":"Channel ID",
            "type":"integer",
            "description":"The channel associated with the action attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "DataSourceLabelAttrib":{
            "title":"Option Label",
            "maxLength":"64",
            "type":"string",
            "description":"The API attribute used as the display value of the action attribute. This applies to action attributes with control type as List.",
            "nullable":true
        },
        "DataSource":{
            "title":"End Point",
            "maxLength":"4000",
            "type":"string",
            "description":"The API to get the a list of values for an attribute of type list.",
            "nullable":true
        },
        "DefaultValue":{
            "title":"Default Value",
            "maxLength":"4000",
            "type":"string",
            "description":"The default value of the action attribute.",
            "nullable":true
        },
        "RequestAttribFlag":{
            "title":"Included in Request",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the action attribute is part of the request payload.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ControlTypeCd":{
            "title":"User Interface Component",
            "maxLength":"30",
            "type":"string",
            "description":"The UI controls used to display the attributes on the collaboration network such as List or Text box.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AttribName":{
            "title":"Attribute Name",
            "maxLength":"64",
            "type":"string",
            "description":"The business object attribute name associated with the collaboration action.",
            "nullable":false
        },
        "ContextAttribFlag":{
            "title":"Business Object Identifier",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the action attribute is used as the context attribute for passing to and from the collaboration network and CX Sales.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DisplayName":{
            "title":"Display Name",
            "maxLength":"64",
            "type":"string",
            "description":"The label of the action attribute displayed when displaying the attribute in the collaboration network.",
            "nullable":true
        },
        "ResponseAttribFlag":{
            "title":"Included in Response",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the action attribute is part of the response payload.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

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 : collaborationActions-item-response

Type: object

Show Source

• actionAttributes: array Action Attributes
  Title: Action Attributes

  The attributes resource lets you view, create, update, and delete attributes used in a collaboration network. These attributes are sent or received from the collaboration network when an action is performed.
• CatalogCd: string
  Title: REST Catalog

  Maximum Length: 30

  Default Value: crmRestApi

  The REST catalog used to generate the endpoint for the business object.
• ChannelId: integer (int64)
  Title: Channel ID

  The unique identifier of the service channel associated with the collaboration action.
• CollabActionCd: string
  Title: Action Code

  Maximum Length: 30

  A unique code that identifier the collaboration action.
• CollabActionId: integer (int64)
  Title: Action ID

  Read Only: true

  The unique identifier of the collaboration action.
• CollabActionMethod: string
  Title: Action Method

  Maximum Length: 64

  The REST API action invoked by the collaboration action such as GET or POST.
• CollabActionName: string
  Title: Action Name

  Maximum Length: 64

  The display name of the collaboration action.
• CollabActionNumber: string
  Title: Action Number

  Maximum Length: 30

  The alternate unique identifier of the collaboration action.
• CollabActionTypeCd: string
  Title: Action Type

  Maximum Length: 30

  Specifies what the collaboration action does when run, such as call an API or show a dialog.
• ControlTypeCd: string
  Title: User Interface Component

  Maximum Length: 30

  The UI controls used to display the action on the collaboration network.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the collaboration action.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the collaboration action was created.
• Description: string
  Title: Description

  Maximum Length: 1000

  The description of the collaboration action.
• DisplaySequence: integer (int64)
  Title: Display Sequence

  The display sequence of the collaboration action. This is primarily applicable to child actions that are displayed on the collaboration network UI.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the collaboration action was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the collaboration action.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login details of the user who last updated the collaboration action.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectName: string
  Title: Business Object

  Maximum Length: 64

  The business object associated with the collaboration action such as service request or opportunity.
• ParentActionId: integer (int64)
  Title: Parent Action ID

  The unique identifier of the parent action for the collaboration action.
• RequestContentType: string
  Title: Request Content Type

  Maximum Length: 64

  The content type of the REST API request payload.
• RequestEndPoint: string
  Title: Request End Point

  Maximum Length: 4000

  The endpoint of the Request API for the collaboration action.
• RequestPayload: string (byte)
  Title: Request Payload

  The request payload for the request API.
• ResponseContentType: string
  Title: Response Content Type

  Maximum Length: 64

  The content type of the REST API response.
• ResponseEntityTypeCd: string
  Title: Response Type

  Maximum Length: 30

  The response type of collaboration actions such as Action Attributes or Payload.
• ResponseMsgTypeCd: string
  Title: Response Visibility

  Maximum Length: 30

  Indicates the visibility of the action response in the collaboration network such as private or public.
• ResponsePayload: string (byte)
  Title: Response Payload

  The response of the collaboration action.
• StatusCd: string
  Title: Status

  Maximum Length: 30

  Default Value: DRAFT

  The status of the collaboration action such as DRAFT or ACTIVE.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the collaboration action was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The description of the collaboration action.",
            "nullable":true,
            "x-queryable":true
        },
        "CatalogCd":{
            "title":"REST Catalog",
            "maxLength":"30",
            "type":"string",
            "description":"The REST catalog used to generate the endpoint for the business object.",
            "nullable":true,
            "default":"crmRestApi",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CollabActionMethod":{
            "title":"Action Method",
            "maxLength":"64",
            "type":"string",
            "description":"The REST API action invoked by the collaboration action such as GET or POST.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The display sequence of the collaboration action. This is primarily applicable to child actions that are displayed on the collaboration network UI.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResponseMsgTypeCd":{
            "title":"Response Visibility",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the visibility of the action response in the collaboration network such as private or public.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "actionAttributes":{
            "title":"Action Attributes",
            "type":"array",
            "description":"The attributes resource lets you view, create, update, and delete attributes used in a collaboration network. These attributes are sent or received from the collaboration network when an action is performed.",
            "items":{
                "$ref":"#/components/schemas/collaborationActions-actionAttributes-item-response"
            }
        },
        "CollabActionId":{
            "title":"Action ID",
            "type":"integer",
            "description":"The unique identifier of the collaboration action.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ChannelId":{
            "title":"Channel ID",
            "type":"integer",
            "description":"The unique identifier of the service channel associated with the collaboration action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResponsePayload":{
            "title":"Response Payload",
            "type":"string",
            "description":"The response of the collaboration action.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "CollabActionTypeCd":{
            "title":"Action Type",
            "maxLength":"30",
            "type":"string",
            "description":"Specifies what the collaboration action does when run, such as call an API or show a dialog.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ControlTypeCd":{
            "title":"User Interface Component",
            "maxLength":"30",
            "type":"string",
            "description":"The UI controls used to display the action on the collaboration network.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RequestContentType":{
            "title":"Request Content Type",
            "maxLength":"64",
            "type":"string",
            "description":"The content type of the REST API request 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"
            }
        },
        "CollabActionName":{
            "title":"Action Name",
            "maxLength":"64",
            "type":"string",
            "description":"The display name of the collaboration action.",
            "nullable":false,
            "x-queryable":true
        },
        "RequestPayload":{
            "title":"Request Payload",
            "type":"string",
            "description":"The request payload for the request API.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the collaboration action.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the collaboration action.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentActionId":{
            "title":"Parent Action ID",
            "type":"integer",
            "description":"The unique identifier of the parent action for the collaboration action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StatusCd":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the collaboration action such as DRAFT or ACTIVE.",
            "nullable":false,
            "default":"DRAFT",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ResponseContentType":{
            "title":"Response Content Type",
            "maxLength":"64",
            "type":"string",
            "description":"The content type of the REST API response.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestEndPoint":{
            "title":"Request End Point",
            "maxLength":"4000",
            "type":"string",
            "description":"The endpoint of the Request API for the collaboration action.",
            "nullable":true,
            "x-queryable":true
        },
        "ResponseEntityTypeCd":{
            "title":"Response Type",
            "maxLength":"30",
            "type":"string",
            "description":"The response type of collaboration actions such as Action Attributes or Payload.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ObjectName":{
            "title":"Business Object",
            "maxLength":"64",
            "type":"string",
            "description":"The business object associated with the collaboration action such as service request or opportunity.",
            "nullable":false,
            "x-queryable":true
        },
        "CollabActionCd":{
            "title":"Action Code",
            "maxLength":"30",
            "type":"string",
            "description":"A unique code that identifier the collaboration action.",
            "nullable":true,
            "x-queryable":true
        },
        "CollabActionNumber":{
            "title":"Action Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate unique identifier of the collaboration action.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the collaboration action was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login details of the user who last updated the collaboration action.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Action Attributes

Type: array

Title: Action Attributes

The attributes resource lets you view, create, update, and delete attributes used in a collaboration network. These attributes are sent or received from the collaboration network when an action is performed.

Show Source

• Array of: object collaborationActions-actionAttributes-item-response

{
    "title":"Action Attributes",
    "type":"array",
    "description":"The attributes resource lets you view, create, update, and delete attributes used in a collaboration network. These attributes are sent or received from the collaboration network when an action is performed.",
    "items":{
        "$ref":"#/components/schemas/collaborationActions-actionAttributes-item-response"
    }
}

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 : collaborationActions-actionAttributes-item-response

Type: object

Show Source

• AttribId: integer (int64)
  Title: Attribute ID

  Read Only: true

  The unique identifier of the action attribute.
• AttribName: string
  Title: Attribute Name

  Maximum Length: 64

  The business object attribute name associated with the collaboration action.
• ChannelId: integer (int64)
  Title: Channel ID

  The channel associated with the action attribute.
• CollabActionId: integer (int64)
  Title: Action ID

  The unique identifier of the collaboration action associated with the attribute.
• ContextAttribFlag: boolean
  Title: Business Object Identifier

  Maximum Length: 1

  Default Value: false

  Indicates if the action attribute is used as the context attribute for passing to and from the collaboration network and CX Sales.
• ControlTypeCd: string
  Title: User Interface Component

  Maximum Length: 30

  The UI controls used to display the attributes on the collaboration network such as List or Text box.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the action attribute.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the action attribute was created.
• DataSource: string
  Title: End Point

  Maximum Length: 4000

  The API to get the a list of values for an attribute of type list.
• DataSourceLabelAttrib: string
  Title: Option Label

  Maximum Length: 64

  The API attribute used as the display value of the action attribute. This applies to action attributes with control type as List.
• DataSourceValueAttrib: string
  Title: Option Value

  Maximum Length: 64

  The API attribute used to save the selected action attribute value. This applies to action attributes with control type as List.
• DataTypeCd: string
  Title: Data Type

  Maximum Length: 30

  The data type of collaboration action attributes such as Date Time or Number.
• DeepLink: string
  Title: Deep Link

  Maximum Length: 1000

  A deep link URL format that links to the object associated with the action attribute.
• DefaultValue: string
  Title: Default Value

  Maximum Length: 4000

  The default value of the action attribute.
• DisplayName: string
  Title: Display Name

  Maximum Length: 64

  The label of the action attribute displayed when displaying the attribute in the collaboration network.
• DisplaySequence: integer (int64)
  Title: Display Sequence

  The display order of the action attribute.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the action attribute was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the action attribute.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login details of the user who last updated the action attributes.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RequestAttribFlag: boolean
  Title: Included in Request

  Maximum Length: 1

  Default Value: false

  Indicates if the action attribute is part of the request payload.
• ResponseAttribFlag: boolean
  Title: Included in Response

  Maximum Length: 1

  Default Value: false

  Indicates if the action attribute is part of the response payload.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the action attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the action attribute was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DataSourceValueAttrib":{
            "title":"Option Value",
            "maxLength":"64",
            "type":"string",
            "description":"The API attribute used to save the selected action attribute value. This applies to action attributes with control type as List.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the action attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The display order of the action attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DeepLink":{
            "title":"Deep Link",
            "maxLength":"1000",
            "type":"string",
            "description":"A deep link URL format that links to the object associated with the action attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "AttribId":{
            "title":"Attribute ID",
            "type":"integer",
            "description":"The unique identifier of the action attribute.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CollabActionId":{
            "title":"Action ID",
            "type":"integer",
            "description":"The unique identifier of the collaboration action associated with the attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DataTypeCd":{
            "title":"Data Type",
            "maxLength":"30",
            "type":"string",
            "description":"The data type of collaboration action attributes such as Date Time or Number.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ChannelId":{
            "title":"Channel ID",
            "type":"integer",
            "description":"The channel associated with the action attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DataSourceLabelAttrib":{
            "title":"Option Label",
            "maxLength":"64",
            "type":"string",
            "description":"The API attribute used as the display value of the action attribute. This applies to action attributes with control type as List.",
            "nullable":true,
            "x-queryable":true
        },
        "DataSource":{
            "title":"End Point",
            "maxLength":"4000",
            "type":"string",
            "description":"The API to get the a list of values for an attribute of type list.",
            "nullable":true,
            "x-queryable":true
        },
        "DefaultValue":{
            "title":"Default Value",
            "maxLength":"4000",
            "type":"string",
            "description":"The default value of the action attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestAttribFlag":{
            "title":"Included in Request",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the action attribute is part of the request payload.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ControlTypeCd":{
            "title":"User Interface Component",
            "maxLength":"30",
            "type":"string",
            "description":"The UI controls used to display the attributes on the collaboration network such as List or Text box.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AttribName":{
            "title":"Attribute Name",
            "maxLength":"64",
            "type":"string",
            "description":"The business object attribute name associated with the collaboration action.",
            "nullable":false,
            "x-queryable":true
        },
        "ContextAttribFlag":{
            "title":"Business Object Identifier",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the action attribute is used as the context attribute for passing to and from the collaboration network and CX Sales.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Display Name",
            "maxLength":"64",
            "type":"string",
            "description":"The label of the action attribute displayed when displaying the attribute in the collaboration network.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ResponseAttribFlag":{
            "title":"Included in Response",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the action attribute is part of the response payload.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the action attribute was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login details of the user who last updated the action attributes.",
            "nullable":true,
            "readOnly":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 : 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."
        }
    }
}

Links

CatalogCdLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_COLLAB_CATALOG_TYPE_CD

The following properties are defined on the LOV link relation:

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

CollabActionMethodLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_COLLAB_ACT_MET_TYPE_CD

The following properties are defined on the LOV link relation:

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

CollabActionTypeCdLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_COLLAB_ACT_TYPE_CD

The following properties are defined on the LOV link relation:

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

ControlTypeCdLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_COLLAB_ACT_CON_TYPE_CD

The following properties are defined on the LOV link relation:

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

ResponseEntityTypeCdLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_COLLAB_RES_ENT_TYPE_CD

The following properties are defined on the LOV link relation:

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

ResponseMsgTypeCdLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_COLLAB_RES_MSG_TYPE_CD

The following properties are defined on the LOV link relation:

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

StatusCdLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_COLLAB_ACT_STATUS_CD

The following properties are defined on the LOV link relation:

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

actionAttributes

Operation: /crmRestApi/resources/11.13.18.05/collaborationActions/{CollabActionNumber}/child/actionAttributes

Parameters:

• CollabActionNumber: $request.path.CollabActionNumber

The attributes resource lets you view, create, update, and delete attributes used in a collaboration network. These attributes are sent or received from the collaboration network when an action is performed.

Back to Top