Get a recruiting agent in the job requisition
get
/hcmRestApi/resources/11.13.18.05/recruitingUIRequisitionAgents/{RequisitionId}
Request
Path Parameters
-
RequisitionId(required): integer
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 -
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 : recruitingUIRequisitionAgents-item-response
Type:
Show Source
object
-
Action: string
Maximum Length:
255
Action. -
AgencyId: integer
Agency ID.
-
AgencyName: string
Maximum Length:
255
Agency name. -
AgentId: integer
Agent ID.
-
agentJobFamilies: array
Agent Job Family on Job Requisition
Title:
Agent Job Family on Job Requisition
The AgentJobFamilyV2 resource is a child of the recruitingUIRequisitionAgents resource and provides details about the job family of the recruiting agent. -
agentLocations: array
Agent Location on Job Requisition
Title:
Agent Location on Job Requisition
The AgentLocationV2 resource is a child of the recruitingUIRequisitionAgents resource and provides details about the location of the recruiting agent. -
AgentName: string
Maximum Length:
255
Agent name. -
ExpirationDate: string
(date-time)
Title:
Invitation Expiration
Expiration date. -
ExpirationStatus: string
Maximum Length:
255
Expiration status. -
GeographyName: string
Maximum Length:
255
Geography name. -
IsInvited: string
Title:
Invitation Status
Maximum Length:255
Invited agent. -
JobFamilyName: string
Title:
Job Family
Maximum Length:255
Job family name. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PublishEndDate: string
(date-time)
Publication end date.
-
RequisitionId: integer
Requisition ID.
-
SuccessfulSubmissionPercent: number
Title:
Successful Applications
Successful submission percentage. -
TimeZone: string
Title:
Time Zone
Maximum Length:255
Time zone.
Nested Schema : Agent Job Family on Job Requisition
Type:
array
Title:
Agent Job Family on Job Requisition
The AgentJobFamilyV2 resource is a child of the recruitingUIRequisitionAgents resource and provides details about the job family of the recruiting agent.
Show Source
Nested Schema : Agent Location on Job Requisition
Type:
array
Title:
Agent Location on Job Requisition
The AgentLocationV2 resource is a child of the recruitingUIRequisitionAgents resource and provides details about the location of the recruiting agent.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingUIRequisitionAgents-agentJobFamilies-item-response
Type:
Show Source
object
-
JobFamilyId: integer
(int64)
Read Only:
true
Job family ID. -
JobFamilyName: string
Read Only:
true
Maximum Length:240
Job family name. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectCxtId: integer
Read Only:
true
Object context ID. -
ObjectCxtJobFamId: integer
(int64)
Read Only:
true
Object context job family ID. -
ObjectId: integer
(int64)
Read Only:
true
Object ID of the agent's job family. -
ObjectTypeCode: string
Read Only:
true
Maximum Length:30
Object type code of the agent's job family. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
Object version number of the agent's job family. -
ObjectVersionNumberFamily: integer
(int32)
Read Only:
true
Object version number family of the agent's job family.
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.
Nested Schema : recruitingUIRequisitionAgents-agentLocations-item-response
Type:
Show Source
object
-
GeographyId: integer
(int64)
Read Only:
true
Geography ID. -
GeographyName: string
Read Only:
true
Maximum Length:255
Geography name of the agent's location. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectCxtId: integer
Read Only:
true
Object context ID of the agent's location. -
ObjectCxtLocId: integer
(int64)
Read Only:
true
Object context location ID. -
ObjectId: integer
(int64)
Read Only:
true
Object ID of the agent's location. -
ObjectTypeCode: string
Read Only:
true
Maximum Length:30
Object type code of the agent's location. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
Object version number of the agent's location. -
ObjectVersionNumberLocation: integer
(int32)
Read Only:
true
Object version number family of the agent's location.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- agentJobFamilies
-
Parameters:
- RequisitionId:
$request.path.RequisitionId
The AgentJobFamilyV2 resource is a child of the recruitingUIRequisitionAgents resource and provides details about the job family of the recruiting agent. - RequisitionId:
- agentLocations
-
Operation: /hcmRestApi/resources/11.13.18.05/recruitingUIRequisitionAgents/{RequisitionId}/child/agentLocationsParameters:
- RequisitionId:
$request.path.RequisitionId
The AgentLocationV2 resource is a child of the recruitingUIRequisitionAgents resource and provides details about the location of the recruiting agent. - RequisitionId: