Get a collaboration recipient
get
/crmRestApi/resources/11.13.18.05/collaborationRecipientLookups/{ResourceId}
Request
Path Parameters
-
ResourceId(required): integer(int64)
The unique identifier of the collaboration resource.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
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).
-
fields: string
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 -
links: string
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
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 : collaborationRecipientLookups-item-response
Type:
Show Source
object
-
AlternateGroupId: string
Title:
Collaboration Network Alternative Group ID
Maximum Length:255
The alternative identifier of the collaboration network team or group that the resource belongs to. -
ChannelId: string
Read Only:
true
Maximum Length:255
The identifier of the CX Sales channel that is associated with the collaboration network workspace. -
CollabGroupId: string
Title:
Collaboration Network Group ID
Maximum Length:255
The identifier of the collaboration network team or group that the resource belongs to. -
CollabGroupName: string
Title:
Collaboration Network Group Name
Maximum Length:255
The name of the collaboration network team or group that the resource belongs to. -
CollabId: string
Title:
Collaboration ID
Maximum Length:255
The identifier of the collaboration resource in the collaboration network. -
DisplayName: string
Title:
Display Name
Maximum Length:400
The display name of the collaboration resource. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Resource Name
Maximum Length:400
The name of the collaboration resource. -
ResourceId: integer
(int64)
Title:
Resource ID
Read Only:true
The unique identifier of the collaboration resource. -
ResourceType: string
Read Only:
true
Maximum Length:255
The display name of the collaboration resource type such as User, Channel, Private Channel. -
ResourceTypeCd: string
Title:
Resource Type
Maximum Length:30
The code indicating the type of the collaboration resource such as USER, PUBLIC_CHANNEL, PRIVATE_CHANNEL. -
TeamId: string
Title:
Team ID
Maximum Length:255
The identifier of the collaboration network workspace that the resource belongs to.
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.
Examples
The following example shows how to get a collaboration recipient by submitting a get request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X
https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/collaborationRecipientLookups/{ResourceId}
Example of Response Body
The following shows an example of the response body in JSON format.
{ "ResourceId": 300100545235362, "ResourceTypeCd": "USER", "TeamId": "TNJP96YT1", "DisplayName": "Gyanaranjan", "Name": "Gyanaranjan", "CollabId": "UN62H41SP", "ChannelId": "300100545319641", "ResourceType": "User", "CollabGroupId": null, "CollabGroupName": null, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/collaborationRecipientLookups/300100545235362", "name": "collaborationRecipientLookups", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/collaborationRecipientLookups/300100545235362", "name": "collaborationRecipientLookups", "kind": "item" } ] }