1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Collaboration Actions

Get all collaboration actions

get

/crmRestApi/resources/11.13.18.05/collaborationActions

Request

Query Parameters
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables

    • CollabActionHierarchyFinder Finds all child actions under the specified action in the action hierarchy.
      Finder Variables
      • BindCollabActionNumber; string; The public unique identifier of the collaboration action.
    • CollabActionNumberFinder Finds a collaboration action by collaboration action number.
      Finder Variables
      • CollabActionNumber; string; The alternate unique identifier of the collaboration action.
    • CollabActionVOAltKey Finds a collaboration action using the alternate key action number.
      Finder Variables
      • CollabActionNumber; string; The alternate unique identifier of the collaboration action.
    • CollabRootActionSearchTermFinder Finds top level collaboration actions that match a search term.
      Finder Variables
      • BindSearchTerm; string; The search term to search for collaboration actions.
    • PrimaryKey Finds a collaboration action by its primary key.
      Finder Variables
      • CollabActionId; integer; The unique identifier of the collaboration action.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • CatalogCd; string; The REST catalog used to generate the endpoint for the business object.
    • ChannelId; integer; The unique identifier of the service channel associated with the collaboration action.
    • CollabActionCd; string; A unique code that identifier the collaboration action.
    • CollabActionId; integer; The unique identifier of the collaboration action.
    • CollabActionMethod; string; The REST API action invoked by the collaboration action such as GET or POST.
    • CollabActionName; string; The display name of the collaboration action.
    • CollabActionNumber; string; The alternate unique identifier of the collaboration action.
    • CollabActionTypeCd; string; Specifies what the collaboration action does when run, such as call an API or show a dialog.
    • ControlTypeCd; string; The UI controls used to display the action on the collaboration network.
    • CreatedBy; string; The user who created the collaboration action.
    • CreationDate; string; The date when the collaboration action was created.
    • Description; string; The description of the collaboration action.
    • DisplaySequence; integer; The display sequence of the collaboration action. This is primarily applicable to child actions that are displayed on the collaboration network UI.
    • LastUpdateDate; string; The date when the collaboration action was last updated.
    • LastUpdateLogin; string; The login details of the user who last updated the collaboration action.
    • LastUpdatedBy; string; The user who last updated the collaboration action.
    • ObjectName; string; The business object associated with the collaboration action such as service request or opportunity.
    • ParentActionId; integer; The unique identifier of the parent action for the collaboration action.
    • RequestContentType; string; The content type of the REST API request payload.
    • RequestEndPoint; string; The endpoint of the Request API for the collaboration action.
    • ResponseContentType; string; The content type of the REST API response.
    • ResponseEntityTypeCd; string; The response type of collaboration actions such as Action Attributes or Payload.
    • ResponseMsgTypeCd; string; Indicates the visibility of the action response in the collaboration network such as private or public.
    • StatusCd; string; The status of the collaboration action such as DRAFT or ACTIVE.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : collaborationActions-item-response
Type: object
Show Source
  • 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.
  • Title: REST Catalog
    Maximum Length: 30
    Default Value: crmRestApi
    The REST catalog used to generate the endpoint for the business object.
  • Title: Channel ID
    The unique identifier of the service channel associated with the collaboration action.
  • Title: Action Code
    Maximum Length: 30
    A unique code that identifier the collaboration action.
  • Title: Action ID
    Read Only: true
    The unique identifier of the collaboration action.
  • Title: Action Method
    Maximum Length: 64
    The REST API action invoked by the collaboration action such as GET or POST.
  • Title: Action Name
    Maximum Length: 64
    The display name of the collaboration action.
  • Title: Action Number
    Maximum Length: 30
    The alternate unique identifier of the collaboration action.
  • Title: Action Type
    Maximum Length: 30
    Specifies what the collaboration action does when run, such as call an API or show a dialog.
  • Title: User Interface Component
    Maximum Length: 30
    The UI controls used to display the action on the collaboration network.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the collaboration action.
  • Title: Creation Date
    Read Only: true
    The date when the collaboration action was created.
  • Title: Description
    Maximum Length: 1000
    The description of the collaboration action.
  • 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.
  • Title: Last Updated Date
    Read Only: true
    The date when the collaboration action was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the collaboration action.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login details of the user who last updated the collaboration action.
  • Links
  • Title: Business Object
    Maximum Length: 64
    The business object associated with the collaboration action such as service request or opportunity.
  • Title: Parent Action ID
    The unique identifier of the parent action for the collaboration action.
  • Title: Request Content Type
    Maximum Length: 64
    The content type of the REST API request payload.
  • Title: Request End Point
    Maximum Length: 4000
    The endpoint of the Request API for the collaboration action.
  • Title: Request Payload
    The request payload for the request API.
  • Title: Response Content Type
    Maximum Length: 64
    The content type of the REST API response.
  • Title: Response Type
    Maximum Length: 30
    The response type of collaboration actions such as Action Attributes or Payload.
  • Title: Response Visibility
    Maximum Length: 30
    Indicates the visibility of the action response in the collaboration network such as private or public.
  • Title: Response Payload
    The response of the collaboration action.
  • 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 : collaborationActions-actionAttributes-item-response
Type: object
Show Source
  • Title: Attribute ID
    Read Only: true
    The unique identifier of the action attribute.
  • Title: Attribute Name
    Maximum Length: 64
    The business object attribute name associated with the collaboration action.
  • Title: Channel ID
    The channel associated with the action attribute.
  • Title: Action ID
    The unique identifier of the collaboration action associated with the attribute.
  • 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.
  • 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.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the action attribute.
  • Title: Creation Date
    Read Only: true
    The date when the action attribute was created.
  • Title: End Point
    Maximum Length: 4000
    The API to get the a list of values for an attribute of type list.
  • 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.
  • 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.
  • Title: Data Type
    Maximum Length: 30
    The data type of collaboration action attributes such as Date Time or Number.
  • Title: Default Value
    Maximum Length: 4000
    The default value of the action attribute.
  • Title: Display Name
    Maximum Length: 64
    The label of the action attribute displayed when displaying the attribute in the collaboration network.
  • Title: Display Sequence
    The display order of the action attribute.
  • Title: Last Updated Date
    Read Only: true
    The date when the action attribute was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the action attribute.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login details of the user who last updated the action attributes.
  • Links
  • Title: Included in Request
    Maximum Length: 1
    Default Value: false
    Indicates if the action attribute is part of the request payload.
  • Title: Included in Response
    Maximum Length: 1
    Default Value: false
    Indicates if the action attribute is part of the response payload.
Back to Top

Examples

The following example shows how to get all collaboration actions by submitting a get request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/collaborationActions

Example of Response Body

The following shows an example of the response body in JSON format.

{
    "items": [
        {
            "CollabActionId": 100100144185911,
            "CollabActionName": "My Accounts",
            "CollabActionMethod": "GET",
            "RequestEndPoint": "/crmRestApi/resources/latest/accounts?finder=MyAccounts&onlyData=true&limit=5",
            "RequestContentType": "application/vnd.oracle.adf.resourceitem+json",
            "ResponseContentType": null,
            "CreationDate": "2020-03-16T17:26:41.877+00:00",
            "CreatedBy": "SEED_DATA_FROM_APPLICATION",
            "LastUpdateDate": "2021-06-10T09:43:07.769+00:00",
            "LastUpdatedBy": "SEED_DATA_FROM_APPLICATION",
            "LastUpdateLogin": "-1",
            "ResponseEntityTypeCd": "OBJECT",
            "ResponseMsgTypeCd": "PRIVATE",
            "CollabActionCd": "/ec-my-accounts",
            "CollabActionTypeCd": "INVOKE_API",
            "ObjectName": "Account",
            "ParentActionId": null,
            "ControlTypeCd": null,
            "DisplaySequence": 1,
            "ChannelId": null,
            "CollabActionNumber": "/ec-my-accounts",
            "Description": null,
            "StatusCd": "ACTIVE",
            "CatalogCd": "crmRestApi",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/collaborationActions/%2Fec-my-accounts",
                    "name": "collaborationActions",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/collaborationActions/%2Fec-my-accounts",
                    "name": "collaborationActions",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/collaborationActions/%2Fec-my-accounts/child/actionAttributes",
                    "name": "actionAttributes",
                    "kind": "collection"
                },
                {
                    "rel": "enclosure",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/collaborationActions/%2Fec-my-accounts/enclosure/RequestPayload",
                    "name": "RequestPayload",
                    "kind": "other"
                },
                {
                    "rel": "enclosure",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/collaborationActions/%2Fec-my-accounts/enclosure/ResponsePayload",
                    "name": "ResponsePayload",
                    "kind": "other"
                }
            ]
        },
  .....
    ],
    "count": 11,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/collaborationActions",
            "name": "collaborationActions",
            "kind": "collection"
        }
    ]
}
Back to Top