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

Get all collaborations

get

/crmRestApi/resources/11.13.18.05/collaborations

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

    • GetCollaborationsForObjectFinder A predefined finder used to search the collection.
      Finder Variables
      • ObjectId; string; The unique identifier of the record that the collaboration is associated to.
      • ObjectName; string; The rest resource name of the object type that's associated to collaboration record such as opportunities.
      • Validate; boolean; Determines whether to validate if the collaboration web URL is still valid in the external collaboration tool. Values are true and false.
    • PrimaryKey Finds the collaborations with the primary key.
      Finder Variables
      • CollabId; string; The unique identifier of the collaboration.
  • 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:
    • CollabId; string; The unique identifier of the collaboration.
    • CreatedBy; string; The user who created the collaboration.
    • CreationDate; string; The date when the collaboration was created.
    • Description; string; The description of the collaboration displayed in the collaboration tool, for example, the description of the team shown in Microsoft Teams.
    • LastUpdateDate; string; The date when the collaboration was last updated.
    • LastUpdateLogin; string; The login details of the user who last updated the collaboration.
    • LastUpdatedBy; string; The user who last updated the collaboration.
    • Name; string; The name of the collaboration displayed in the collaboration tool, for example, the team name shown in Microsoft Teams.
    • ObjectId; string; The unique identifier of the record that the collaboration is associated to such as the opportunity ID.
    • ObjectName; string; The rest resource name of the object type of the record that the collaboration is associated to such as opportunities.
    • Weburl; string; The external URL to the collaboration in the collaboration tool, for example, the URL to Team in Microsoft Teams.
  • 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 : collaborations
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : collaborations-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 64
    The unique identifier of the collaboration.
  • Read Only: true
    Maximum Length: 64
    The user who created the collaboration.
  • Read Only: true
    The date when the collaboration was created.
  • Maximum Length: 1024
    The description of the collaboration displayed in the collaboration tool, for example, the description of the team shown in Microsoft Teams.
  • Read Only: true
    The date when the collaboration was last updated.
  • Read Only: true
    Maximum Length: 64
    The user who last updated the collaboration.
  • Read Only: true
    Maximum Length: 32
    The login details of the user who last updated the collaboration.
  • Links
  • Maximum Length: 128
    The name of the collaboration displayed in the collaboration tool, for example, the team name shown in Microsoft Teams.
  • Maximum Length: 64
    The unique identifier of the record that the collaboration is associated to such as the opportunity ID.
  • Maximum Length: 128
    The rest resource name of the object type of the record that the collaboration is associated to such as opportunities.
  • Maximum Length: 80
    The name of the relationship between Resource team object and the object type that the collaboration is associated to. This is used when object type is a custom object.
  • Read Only: true
    Maximum Length: 512
    The external URL to the collaboration in the collaboration tool, for example, the URL to Team in Microsoft Teams.
Back to Top

Examples

The following example shows how to get all collaborations by submitting a GET request on the REST resource.

cURL Command

curl -u <username:password> \
 -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/collaborations/  \
 -H 'Content-Type: application/vnd.oracle.adf.resourceitem+json'  | json_pp

Example of Response Body

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

{
    "items": [
        {
            "CollabId": "300100565031495",
            "CreatedBy": "MHoope",
            "CreationDate": "2022-11-14T10:52:27.004+00:00",
            "LastUpdateDate": "2022-11-14T10:52:27.005+00:00",
            "LastUpdateLogin": null,
            "LastUpdatedBy": "MHoope",
            "Weburl": "https://teams.microsoft.com/l/team/19%3a2kyClEznOdMa9cPBTQu2D-aKua5zl9-rdx4pYrCDkHU1%40thread.tacv2/conversations?groupId=75292f03-d7af-4b20-a4bc-5ca29351c7fb&tenantId=33b71f2d-7f52-4370-bd2c-08efb530b1c3",
            "ObjectId": "300100565031470",
            "ObjectName": "accounts",
            "Name": "Accounts - AccountTestingDes",
            "Description": "This team is specifically for the AccountTestingDes account: abcd",
            "TeamRelationshipName": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/collaborations/300100565031495",
                    "name": "collaborations",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/collaborations/300100565031495",
                    "name": "collaborations",
                    "kind": "item"
                }
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/collaborations",
            "name": "collaborations",
            "kind": "collection"
        }
    ]
}
Back to Top