Get all resource team members
get
/crmRestApi/resources/11.13.18.05/queues/{QueueId}/child/resourceTeams/{QueueResourceId}/child/resourceTeamMembers
Request
Path Parameters
-
QueueId(required): integer(int64)
The unique identifier of the queue.
-
QueueResourceId(required): integer(int64)
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=
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 -
finder: string
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:- PrimaryKey: Finds a resource team member with the specified primary key.
Finder Variables:- TeamMemberId; integer; The unique identifier of the queue resource team members.
- PrimaryKey: Finds a resource team member with the specified primary key.
-
limit: integer
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.
-
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 -
offset: integer
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.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
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
-
q: string
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:- CreatedBy; string; The date and time when the queue resource team was created.
- CreationDate; string; Indicates if the resource team can be deleted. The default value is true.
- DeleteFlag; boolean; Indicates whether the row can be deleted. Possible values are 'Y' and 'N'.
- DenormMgrId; integer; The identifier of this resource's manager.
- EmailAddress; string; The email address of the resource.
- LastUpdateDate; string; The date and time when the queue resource member was last updated.
- LastUpdateLogin; string; The application login associated with the user who last updated the queue resource member.
- LastUpdatedBy; string; The user who last updated the queue resource member.
- ManagerName; string; The name of this team members manager.
- OrganizationName; string; The name of the resource organization.
- PartyId; integer; The party id of the resource.
- PartyName; string; The party name of the resource.
- PartyNumber; string; The party number of the resource.
- PartyUniqueName; string; The unique party name of the resource.
- PersonName; string; The name of the resource.
- ReportsToCode; string; Indicates whether the resource reports to a manager. Possible values are 'Y', 'N' and 'T'.
- ResourceProfileId; integer; The identifier of the resource's profile.
- ResourceType; string; Indicates the type of the resource.
- RoleName; string; The name of the resource role.
- TeamId; integer; The unique identifier of the team.
- TeamMemberId; integer; The unique identifier of the team member.
- TeamResourceId; integer; The unique identifier of the resource that is a member of a team.
-
totalResults: boolean
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
-
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 : queues-resourceTeams-resourceTeamMembers
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : queues-resourceTeams-resourceTeamMembers-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The date and time when the queue resource team was created. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Indicates if the resource team can be deleted. The default value is true. -
DeleteFlag: boolean
Title:
Delete Indicator
Maximum Length:1
Default Value:false
Indicates whether the row can be deleted. Possible values are 'Y' and 'N'. -
DenormMgrId: integer
(int64)
Title:
Manager Id
Read Only:true
The identifier of this resource's manager. -
EmailAddress: string
Title:
Email Address
Read Only:true
Maximum Length:320
The email address of the resource. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the queue resource member was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the queue resource member. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The application login associated with the user who last updated the queue resource member. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManagerName: string
Title:
Manager Name
Read Only:true
Maximum Length:360
The name of this team members manager. -
OrganizationName: string
Title:
Resource Organization
Read Only:true
Maximum Length:240
The name of the resource organization. -
PartyId: integer
(int64)
Title:
Party Id
Read Only:true
The party id of the resource. -
PartyName: string
Title:
Party Name
Read Only:true
Maximum Length:360
The party name of the resource. -
PartyNumber: string
Title:
Party Number
Read Only:true
Maximum Length:30
The party number of the resource. -
PartyUniqueName: string
Title:
Party Unique Name
Read Only:true
Maximum Length:900
The unique party name of the resource. -
PersonName: string
Title:
Person Name
Read Only:true
Maximum Length:450
The name of the resource. -
ReportsToCode: string
Title:
Reports to Indicator
Read Only:true
Maximum Length:1
Indicates whether the resource reports to a manager. Possible values are 'Y', 'N' and 'T'. -
ResourceProfileId: integer
(int64)
Title:
Resource Profile Id
Read Only:true
The identifier of the resource's profile. -
ResourceType: string
Title:
Resource Type
Maximum Length:30
Indicates the type of the resource. -
RoleName: string
Title:
Role Name
Read Only:true
Maximum Length:60
The name of the resource role. -
TeamId: integer
Title:
Team Id
The unique identifier of the team. -
TeamMemberId: integer
Title:
Team Member Id
Read Only:true
The unique identifier of the team member. -
TeamResourceId: integer
Title:
Team Resource Id
The unique identifier of the resource that is a member of a team.
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 all resource team members by submitting a GET request on the REST resource using cURL.
curl -u <username:password> \ -X GET -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/queues/300100551304254/child/resourceTeams/300100551822474/child/resourceTeamMembers
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "items": [ { "TeamId": 300100551812952, "TeamMemberId": 300100551812955, "TeamResourceId": 5880, "ResourceType": "INDIVIDUAL", "DeleteFlag": false, "CreatedBy": "SALES_ADMIN", "CreationDate": "2022-05-25T07:51:41.459+00:00", "LastUpdateDate": "2022-05-25T07:52:15.080+00:00", "LastUpdateLogin": "DF0B827855905EEAE0531C5CF00A8C23", "LastUpdatedBy": "SALES_ADMIN", "PersonName": "Lisa Jones", "ResourceProfileId": 100000001163289, "EmailAddress": "sendmail-test-discard@oracle.com", "RoleName": null, "DenormMgrId": null, "OrganizationName": null, "ManagerName": null, "ReportsToCode": null, "PartyName": "Lisa Jones", "PartyId": 5880, "PartyNumber": "4274", "PartyUniqueName": "Lisa Jones ", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/queues/300100551304254/child/resourceTeams/300100551822474/child/resourceTeamMembers/300100551812955", "name": "resourceTeamMembers", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/queues/300100551304254/child/resourceTeams/300100551822474/child/resourceTeamMembers/300100551812955", "name": "resourceTeamMembers", "kind": "item" }, { "rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/queues/300100551304254/child/resourceTeams/300100551822474", "name": "resourceTeams", "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/queues/300100551304254/child/resourceTeams/300100551822474/child/resourceTeamMembers", "name": "resourceTeamMembers", "kind": "collection" } ] }