Get all contact members
get
/crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/contacts
Request
Path Parameters
-
SrId(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 service request contacts with the specified primary key.
Finder Variables:- MemberId :The unique identifier of a service request contact.
- SrContactMemberAltKeyFinder :Finds a service request contact record using its alternate key.
Finder Variables:- ContactPartyNumber :The public unique identifier of the service request contact.
- SrNumber :The public unique identifier of the service request.
- PrimaryKey :Finds a service request contacts 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:- AccessLevelCd; string; The access level granted to the service request contact.
- AccountName; string; The primary account of the service request contact.
- ContactEmailAddress; string; The email address of the contact.
- ContactFormattedPhoneNumber; string; The formatted phone number of the contact.
- ContactPartyName; string; The name of a service request contact.
- ContactPartyNumber; string; The alternative key for the contact identifier.
- ContactPreferredContactMethod; string; The preferred contact method of the contact.
- ContactTypeCd; string; The service request contact type such as Customer or Partner.
- ContactUniqueName; string; The unique party name of the contact.
- CreatedBy; string; The user who added the contact as a member of the service request.
- CreationDate; string; The date and time when the record was created.
- DoNotContactFlag; boolean; Indicates whether the contact of the service request doesn't want to be contacted.
- JobTitle; string; The job title of the service request contact.
- LastUpdateDate; string; The date and time when the record was last updated.
- LastUpdateLogin; string; The login of the user who last update the contact's object associated with the service request.
- LastUpdatedBy; string; The user who last updated the service request contact member record.
- MemberId; integer; The unique identifier of the contact.
- PartyId; integer; The unique party identifier of the contact.
- PersonId; integer; The unique person ID of the contact.
- RelationTypeCd; string; The relationship with the contact in context of the service request. For example, Alternate, Follower, Third_Party, and so on.
- SrId; integer; The unique identifier of the associated service request.
- SrNumber; string; The alternative key for the service request number.
-
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 : hrHelpDeskRequests-contacts
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 : hrHelpDeskRequests-contacts-item-response
Type:
Show Source
object
-
AccessLevelCd: string
Title:
Access Level
Maximum Length:30
The access level granted to the service request contact. -
AccountName: string
Title:
Account Name
Read Only:true
Maximum Length:900
The primary account of the service request contact. -
ContactEmailAddress: string
Title:
Email
Read Only:true
Maximum Length:320
The email address of the contact. -
ContactFormattedPhoneNumber: string
Title:
Phone
Read Only:true
The formatted phone number of the contact. -
ContactPartyName: string
Title:
Name
Maximum Length:360
The name of a service request contact. -
ContactPartyNumber: string
Title:
Contact Number
Read Only:true
Maximum Length:30
The alternative key for the contact identifier. -
ContactPreferredContactMethod: string
Title:
Preferred Contact Method
Read Only:true
Maximum Length:30
The preferred contact method of the contact. -
ContactTypeCd: string
Title:
Contact Type
Maximum Length:30
The service request contact type such as Customer or Partner. -
ContactUniqueName: string
Title:
Unique Name
Maximum Length:900
The unique party name of the contact. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who added the contact as a member of the service request. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the record was created. -
DeleteFlag: boolean
Title:
Can Delete
Read Only:true
Indicates whether the user has access to delete the record. -
DoNotContactFlag: boolean
Title:
Do Not Contact
Read Only:true
Maximum Length:1
Indicates whether the contact of the service request doesn't want to be contacted. -
FormattedAddress: string
Title:
Formatted Address
Read Only:true
Indicates the formatted address of the service request contact. -
JobTitle: string
Title:
Job Title
Read Only:true
Maximum Length:100
The job title of the service request contact. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the service request contact member record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last update the contact's object associated with the service request. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MemberId: integer
(int64)
Title:
Member ID
The unique identifier of the contact. -
PartyId: integer
(int64)
Title:
Party ID
The unique party identifier of the contact. -
PersonId: integer
(int64)
Title:
Person ID
The unique person ID of the contact. -
PrimaryContactFlag: boolean
Title:
Primary
Indicates whether the contact is the primary contact for the service request. If yes, the value is True, else the value is False. -
RelationTypeCd: string
Title:
Relationship Type Code
Maximum Length:30
The relationship with the contact in context of the service request. For example, Alternate, Follower, Third_Party, and so on. -
SrId: integer
(int64)
Title:
Service Request ID
The unique identifier of the associated service request. -
SrNumber: string
Title:
Service Request Number
Maximum Length:30
The alternative key for the service request number. -
UpdateFlag: boolean
Title:
Can Update
Read Only:true
Indicates whether the user has access to update the record.
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.