Get an interaction
get
/hcmRestApi/resources/11.13.18.05/recruitingUIInteractions/{recruitingUIInteractionsUniqID}
Request
Path Parameters
-
recruitingUIInteractionsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- InteractionId, ContextTypeCode and InteractionView ---for the Recruiting Interactions resource and used to uniquely identify an instance of Recruiting Interactions. The client should not generate the hash key value. Instead, the client should query on the Recruiting Interactions collection resource with a filter on the primary key values in order to navigate to a specific instance of Recruiting Interactions.
For example: recruitingUIInteractions?q=InteractionId=<value1>;ContextTypeCode=<value2>;InteractionView=<value3>
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 : recruitingUIInteractions-item-response
Type:
Show Source
object
-
AddedByPersonId: integer
Read Only:
true
Unique identifier of the person who added the interaction. -
ContextId: integer
Read Only:
true
Unique identifier of the context. -
ContextTypeCode: string
Title:
Context
Read Only:true
Maximum Length:30
Code of the context type -
DisplayName: string
Title:
Name
Read Only:true
Display name of the interaction. -
EventName: string
Read Only:
true
Name of the event of the interaction. -
EventNumber: string
Read Only:
true
Number of the event of the interaction. -
HiringTeamInternalFlag: boolean
Read Only:
true
Maximum Length:1
Indicates whether the interaction is internal to the hiring team. -
InteractionDate: string
Title:
Interaction Date
Read Only:true
Date of the interaction. -
InteractionId: integer
Read Only:
true
Unique identifier of the interaction. -
InteractionRecipients: array
Recruiting Interaction Recipients
Title:
Recruiting Interaction Recipients
The interactionRecipients resource is the child of the recruitingUIInteractions resource and provides the details of the recipients for a given recruiting interaction. -
InteractionTypeCode: string
Read Only:
true
Maximum Length:30
Code of the type of interaction. -
InteractionTypeLabel: string
Title:
Interaction Type
Read Only:true
Label of the type of interaction. -
InteractionView: string
Read Only:
true
Type of interaction view. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PersonId: integer
Read Only:
true
Unique identifier of the person. -
PoolName: string
Read Only:
true
Name of the pool to which the interaction is related. -
RequisitionNumber: string
Read Only:
true
Requisition number of the requisition to which the interaction is related. -
Text: string
Title:
Interaction Note
Read Only:true
Text of the interaction. -
Title: string
Read Only:
true
Title of the interaction.
Nested Schema : Recruiting Interaction Recipients
Type:
array
Title:
Recruiting Interaction Recipients
The interactionRecipients resource is the child of the recruitingUIInteractions resource and provides the details of the recipients for a given recruiting interaction.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingUIInteractions-InteractionRecipients-item-response
Type:
Show Source
object
-
AgentId: integer
Read Only:
true
Unique identifier of the agent. -
ContextTypeCode: string
Read Only:
true
Code of the context type. -
DisplayName: string
Read Only:
true
Display name of the recipient. -
InteractionId: integer
Read Only:
true
Unique identifier of the interaction. -
InteractionRecipientId: integer
Read Only:
true
Unique identifier of the interaction recipient. -
InteractionView: string
Read Only:
true
Type of interaction view. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PersonId: integer
Read Only:
true
Unique identifier of the person.
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.
Links
- InteractionRecipients
-
Parameters:
- recruitingUIInteractionsUniqID:
$request.path.recruitingUIInteractionsUniqID
The interactionRecipients resource is the child of the recruitingUIInteractions resource and provides the details of the recipients for a given recruiting interaction. - recruitingUIInteractionsUniqID: