Create an interaction
post
/hcmRestApi/resources/11.13.18.05/recruitingUIInteractions
Request
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
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.
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 : recruitingUIInteractions-InteractionRecipients-item-post-request
Type:
Show Source
object
Response
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: