Update a collaboration action
patch
/crmRestApi/resources/11.13.18.05/collaborationActions/{CollabActionNumber}
Request
Path Parameters
-
CollabActionNumber(required): string
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
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: string
Title:
Action Name
Maximum Length:64
The display name 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: 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.
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
Nested Schema : schema
Type:
Show Source
object
-
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.
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.
Root Schema : collaborationActions-item-response
Type:
Show Source
object
-
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.
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
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : collaborationActions-actionAttributes-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- CatalogCdLOV
-
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
- finder:
- CollabActionMethodLOV
-
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
- finder:
- CollabActionTypeCdLOV
-
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
- finder:
- ControlTypeCdLOV
-
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
- finder:
- ResponseEntityTypeCdLOV
-
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
- finder:
- ResponseMsgTypeCdLOV
-
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
- finder:
- StatusCdLOV
-
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
- finder:
- actionAttributes
-
Operation: /crmRestApi/resources/11.13.18.05/collaborationActions/{CollabActionNumber}/child/actionAttributesParameters:
- 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. - CollabActionNumber: