Jump to

• Request
• Response

Get the requisition activity items for a recruiter or hiring manager on the requisition hiring team

get

/hcmRestApi/resources/11.13.18.05/recruitingRACItems/{SubscriberTypeCode}/child/requisitionList/{requisitionListUniqID}

Request

Path Parameters

• SubscriberTypeCode(required): string
  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=
• requisitionListUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Job Requisition List resource and used to uniquely identify an instance of Job Requisition List. The client should not generate the hash key value. Instead, the client should query on the Job Requisition List collection resource in order to navigate to a specific instance of Job Requisition List to get the hash key.

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

• Effective-Of: string
  This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
• Metadata-Context: string
  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: string
  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 Top

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.

Body ()

Root Schema : recruitingRACItems-requisitionList-item-response

Type: object

Show Source

• ActionDate: string (date)
  Title: Date

  Action date of a requisition activity item.
• actions: array Job Requisition Actions List
  Title: Job Requisition Actions List

  The actions resource is the child of the recruitingRACItems resource. It provides a list of job requisition actions that a user can take based on the requisition activity item.
• DefaultAction: string
  Read Only: true

  Maximum Length: 30

  Default action of the requisition activity item.
• DefaultActionName: string
  Read Only: true

  Maximum Length: 255

  Name of the default action for the requisition activity item.
• HiringManager: string
  Title: Hiring Manager

  Read Only: true

  Maximum Length: 240

  Name of the hiring manager of the requisition for the activity item.
• HiringManagerId: integer (int64)
  Read Only: true

  Person identifier of the hiring manager associated with the activity item.
• ItemId: integer (int64)
  Read Only: true

  Unique identifier of the requisition activity item.
• ItemName: string
  Title: Activity

  Read Only: true

  Maximum Length: 240

  Name of the requisition activity item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LookupCode: string
  Title: Lookup Code

  Read Only: true

  Maximum Length: 30

  Lookup code for requisition activity item.
• LookupType: string
  Title: Lookup Type

  Read Only: true

  Maximum Length: 30

  Lookup type for requisition activity item.
• Priority: string
  Title: Priority

  Read Only: true

  Maximum Length: 80

  Requisition activity item priority. Can be high or null.
• PriorityCode: string
  Read Only: true

  Maximum Length: 30

  Rule priority code the requisition activity relates to.
• Recruiter: string
  Title: Recruiter

  Read Only: true

  Maximum Length: 240

  Name of the recruiter of the requisition for the activity item.
• RecruiterId: integer (int64)
  Read Only: true

  Person identifier of the recruiter associated with the activity item.
• requisitionActionPreviews: array Job Requisition Action Previews
  Title: Job Requisition Action Previews

  The requisitionActionPreviews resource is the child of the recruitingRACItems resource. It provides a preview displaying data about the requisition based on the action being performed.
• RequisitionId: integer (int64)
  Read Only: true

  Requisition ID of the requisition associated with the requisition activity item.
• RequisitionNumber: string
  Title: Requisition Number

  Read Only: true

  Maximum Length: 240

  Requisition number of the requisition associated with the requisition activity item.
• requisitionPreviews: array Job Requisition Preview
  Title: Job Requisition Preview

  The requisitionPreviews is the child of the recruitingRACItems resource. It provides a preview of the details of a job requisition.
• RequisitionTitle: string
  Title: Requisition

  Read Only: true

  Maximum Length: 240

  Requisition title of the requisition associated with the requisition activity item.
• Subject: string
  Read Only: true

  Maximum Length: 30

  Subject associated with the job requisition.
• SubscriberLookupCode: string
  Title: Lookup Code

  Read Only: true

  Maximum Length: 30

  Lookup code of the subscriber associated with the activity item.
• SubscriberLookupType: string
  Title: Lookup Type

  Read Only: true

  Maximum Length: 30

  Lookup type of the subscriber associated with the activity item.
• SubscriberRuleCode: string
  Read Only: true

  Maximum Length: 30

  Subscriber rule code of the requisition activity item.
• SubscriberTypeMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Subscriber type meaning of the subscriber associated with the activity item.

{
    "type":"object",
    "properties":{
        "SubscriberLookupType":{
            "title":"Lookup Type",
            "maxLength":30,
            "type":"string",
            "description":"Lookup type of the subscriber associated with the activity item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PriorityCode":{
            "maxLength":30,
            "type":"string",
            "description":"Rule priority code the requisition activity relates to.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "requisitionActionPreviews":{
            "title":"Job Requisition Action Previews",
            "type":"array",
            "description":"The requisitionActionPreviews resource is the child of the recruitingRACItems resource. It provides a preview displaying data about the requisition based on the action being performed.",
            "items":{
                "$ref":"#/components/schemas/recruitingRACItems-requisitionList-requisitionActionPreviews-item-response"
            },
            "x-cardinality":"1"
        },
        "ItemId":{
            "type":"integer",
            "description":"Unique identifier of the requisition activity item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "requisitionPreviews":{
            "title":"Job Requisition Preview",
            "type":"array",
            "description":"The requisitionPreviews is the child of the recruitingRACItems resource. It provides a preview of the details of a job requisition.",
            "items":{
                "$ref":"#/components/schemas/recruitingRACItems-requisitionList-requisitionPreviews-item-response"
            },
            "x-cardinality":"1"
        },
        "RequisitionNumber":{
            "title":"Requisition Number",
            "maxLength":240,
            "type":"string",
            "description":"Requisition number of the requisition associated with the requisition activity item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionDate":{
            "title":"Date",
            "type":"string",
            "description":"Action date of a requisition activity item.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "RequisitionId":{
            "type":"integer",
            "description":"Requisition ID of the requisition associated with the requisition activity item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SubscriberRuleCode":{
            "maxLength":30,
            "type":"string",
            "description":"Subscriber rule code of the requisition activity item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemName":{
            "title":"Activity",
            "maxLength":240,
            "type":"string",
            "description":"Name of the requisition activity item.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubscriberLookupCode":{
            "title":"Lookup Code",
            "maxLength":30,
            "type":"string",
            "description":"Lookup code of the subscriber associated with the activity item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultActionName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the default action for the requisition activity item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LookupType":{
            "title":"Lookup Type",
            "maxLength":30,
            "type":"string",
            "description":"Lookup type for requisition activity item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Priority":{
            "title":"Priority",
            "maxLength":80,
            "type":"string",
            "description":"Requisition activity item priority. Can be high or null.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecruiterId":{
            "type":"integer",
            "description":"Person identifier of the recruiter associated with the activity item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "HiringManager":{
            "title":"Hiring Manager",
            "maxLength":240,
            "type":"string",
            "description":"Name of the hiring manager of the requisition for the activity item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Subject":{
            "maxLength":30,
            "type":"string",
            "description":"Subject associated with the job requisition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubscriberTypeMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Subscriber type meaning of the subscriber associated with the activity item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LookupCode":{
            "title":"Lookup Code",
            "maxLength":30,
            "type":"string",
            "description":"Lookup code for requisition activity item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultAction":{
            "maxLength":30,
            "type":"string",
            "description":"Default action of the requisition activity item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HiringManagerId":{
            "type":"integer",
            "description":"Person identifier of the hiring manager associated with the activity item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "actions":{
            "title":"Job Requisition Actions List",
            "type":"array",
            "description":"The actions resource is the child of the recruitingRACItems resource. It provides a list of job requisition actions that a user can take based on the requisition activity item.",
            "items":{
                "$ref":"#/components/schemas/recruitingRACItems-requisitionList-actions-item-response"
            }
        },
        "Recruiter":{
            "title":"Recruiter",
            "maxLength":240,
            "type":"string",
            "description":"Name of the recruiter of the requisition for the activity item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequisitionTitle":{
            "title":"Requisition",
            "maxLength":240,
            "type":"string",
            "description":"Requisition title of the requisition associated with the requisition activity item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Job Requisition Actions List

Type: array

Title: Job Requisition Actions List

The actions resource is the child of the recruitingRACItems resource. It provides a list of job requisition actions that a user can take based on the requisition activity item.

Show Source

• Array of: object recruitingRACItems-requisitionList-actions-item-response

{
    "title":"Job Requisition Actions List",
    "type":"array",
    "description":"The actions resource is the child of the recruitingRACItems resource. It provides a list of job requisition actions that a user can take based on the requisition activity item.",
    "items":{
        "$ref":"#/components/schemas/recruitingRACItems-requisitionList-actions-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Job Requisition Action Previews

Type: array

Title: Job Requisition Action Previews

The requisitionActionPreviews resource is the child of the recruitingRACItems resource. It provides a preview displaying data about the requisition based on the action being performed.

Show Source

• Array of: object recruitingRACItems-requisitionList-requisitionActionPreviews-item-response

{
    "title":"Job Requisition Action Previews",
    "type":"array",
    "description":"The requisitionActionPreviews resource is the child of the recruitingRACItems resource. It provides a preview displaying data about the requisition based on the action being performed.",
    "items":{
        "$ref":"#/components/schemas/recruitingRACItems-requisitionList-requisitionActionPreviews-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Job Requisition Preview

Type: array

Title: Job Requisition Preview

The requisitionPreviews is the child of the recruitingRACItems resource. It provides a preview of the details of a job requisition.

Show Source

• Array of: object recruitingRACItems-requisitionList-requisitionPreviews-item-response

{
    "title":"Job Requisition Preview",
    "type":"array",
    "description":"The requisitionPreviews is the child of the recruitingRACItems resource. It provides a preview of the details of a job requisition.",
    "items":{
        "$ref":"#/components/schemas/recruitingRACItems-requisitionList-requisitionPreviews-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : recruitingRACItems-requisitionList-actions-item-response

Type: object

Show Source

• ActionCode: string
  Maximum Length: 30

  Action code the job requisition activity item relates to.
• ActionName: string
  Read Only: true

  Maximum Length: 255

  Action name the job requisition activity item relates to.
• DefaultFlag: boolean
  Maximum Length: 1

  Indicates whether the job requisition action is the default action for the activity item. If an action is the default action for an activity item it's displayed in the action column in the activity list.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "ActionCode":{
            "maxLength":30,
            "type":"string",
            "description":"Action code the job requisition activity item relates to.",
            "nullable":false,
            "x-queryable":true
        },
        "ActionName":{
            "maxLength":255,
            "type":"string",
            "description":"Action name the job requisition activity item relates to.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DefaultFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the job requisition action is the default action for the activity item. If an action is the default action for an activity item it's displayed in the action column in the activity list.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : recruitingRACItems-requisitionList-requisitionActionPreviews-item-response

Type: object

Show Source

• AdditionalLocCount: integer
  Read Only: true

  Count of the additional locations associated with the requisition.
• AdditionalWorkLocCount: integer
  Read Only: true

  Count of the additional work locations associated with the requisition.
• HiringManager: string
  Title: Hiring Manager

  Read Only: true

  Maximum Length: 240

  Name of the hiring manager associated with the requisition.
• Job: string
  Title: Job

  Read Only: true

  Maximum Length: 240

  Job associated to the requisition.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Location: string
  Title: Location

  Read Only: true

  Maximum Length: 255

  Location defined on the requisition.
• NumberOfHires: integer (int32)
  Title: Hired Count

  Read Only: true

  Number of hires for the requisition.
• NumberOfJobApplications: integer
  Title: Number of Job Applications

  Read Only: true

  Number of job applications submitted to the requisition.
• NumberOfOpenings: string
  Title: Number of Openings

  Read Only: true

  Maximum Length: 255

  Number of openings for the requisition.
• NumberOfProspects: integer (int32)
  Title: Number of Prospects

  Read Only: true

  Number of prospect candidates associated with the requisition.
• Organization: string
  Title: Organization

  Read Only: true

  Maximum Length: 255

  Organization associated to the requisition.
• OtherRequisitionTitle: string
  Title: Other Requisition Title

  Read Only: true

  Maximum Length: 240

  Other requisition title of the requisition.
• PhaseName: string
  Title: Phase

  Read Only: true

  Maximum Length: 240

  Phase of the requisition in the requisition life cycle.
• Position: string
  Title: Position

  Read Only: true

  Maximum Length: 750

  Position associated to the requisition.
• Recruiter: string
  Title: Recruiter

  Read Only: true

  Maximum Length: 240

  Name of the recruiter associated with the requisition.
• RecruitingType: string
  Title: Recruiting Type

  Read Only: true

  Maximum Length: 255

  Recruiting type defined on the requisition. For example, professional or hourly.
• RequisitionId: integer (int64)
  Read Only: true

  Requisition ID of the requisition.
• RequisitionNumber: string
  Title: Requisition Number

  Read Only: true

  Maximum Length: 240

  Requisition number of the requisition.
• RequisitionStatus: string
  Title: Requisition Status

  Read Only: true

  Maximum Length: 255

  Status of the requisition in the requisition life cycle.
• RequisitionTitle: string
  Title: Requisition Title

  Read Only: true

  Maximum Length: 240

  Title of the requisition.
• RequisitionType: string
  Title: Requisition Type

  Read Only: true

  Maximum Length: 255

  Requisition type of the requisition, either pipeline or standard.
• StateName: string
  Title: State

  Read Only: true

  Maximum Length: 240

  State of the requisition in the requisition life cycle.
• WorkLocation: string
  Title: Work Location

  Read Only: true

  Maximum Length: 255

  Work location of the requisition.

{
    "type":"object",
    "properties":{
        "AdditionalWorkLocCount":{
            "type":"integer",
            "description":"Count of the additional work locations associated with the requisition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Organization":{
            "title":"Organization",
            "maxLength":255,
            "type":"string",
            "description":"Organization associated to the requisition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Position":{
            "title":"Position",
            "maxLength":750,
            "type":"string",
            "description":"Position associated to the requisition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StateName":{
            "title":"State",
            "maxLength":240,
            "type":"string",
            "description":"State of the requisition in the requisition life cycle.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkLocation":{
            "title":"Work Location",
            "maxLength":255,
            "type":"string",
            "description":"Work location of the requisition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NumberOfOpenings":{
            "title":"Number of Openings",
            "maxLength":255,
            "type":"string",
            "description":"Number of openings for the requisition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PhaseName":{
            "title":"Phase",
            "maxLength":240,
            "type":"string",
            "description":"Phase of the requisition in the requisition life cycle.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AdditionalLocCount":{
            "type":"integer",
            "description":"Count of the additional locations associated with the requisition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HiringManager":{
            "title":"Hiring Manager",
            "maxLength":240,
            "type":"string",
            "description":"Name of the hiring manager associated with the requisition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequisitionNumber":{
            "title":"Requisition Number",
            "maxLength":240,
            "type":"string",
            "description":"Requisition number of the requisition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequisitionStatus":{
            "title":"Requisition Status",
            "maxLength":255,
            "type":"string",
            "description":"Status of the requisition in the requisition life cycle.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NumberOfJobApplications":{
            "title":"Number of Job Applications",
            "type":"integer",
            "description":"Number of job applications submitted to the requisition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequisitionId":{
            "type":"integer",
            "description":"Requisition ID of the requisition.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "NumberOfProspects":{
            "title":"Number of Prospects",
            "type":"integer",
            "description":"Number of prospect candidates associated with the requisition.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "RequisitionType":{
            "title":"Requisition Type",
            "maxLength":255,
            "type":"string",
            "description":"Requisition type of the requisition, either pipeline or standard.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecruitingType":{
            "title":"Recruiting Type",
            "maxLength":255,
            "type":"string",
            "description":"Recruiting type defined on the requisition. For example, professional or hourly.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OtherRequisitionTitle":{
            "title":"Other Requisition Title",
            "maxLength":240,
            "type":"string",
            "description":"Other requisition title of the requisition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Job":{
            "title":"Job",
            "maxLength":240,
            "type":"string",
            "description":"Job associated to the requisition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NumberOfHires":{
            "title":"Hired Count",
            "type":"integer",
            "description":"Number of hires for the requisition.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "RequisitionTitle":{
            "title":"Requisition Title",
            "maxLength":240,
            "type":"string",
            "description":"Title of the requisition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Recruiter":{
            "title":"Recruiter",
            "maxLength":240,
            "type":"string",
            "description":"Name of the recruiter associated with the requisition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Location":{
            "title":"Location",
            "maxLength":255,
            "type":"string",
            "description":"Location defined on the requisition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : recruitingRACItems-requisitionList-requisitionPreviews-item-response

Type: object

Show Source

• AdditionalLocCount: string
  Read Only: true

  Maximum Length: 255

  Count of the additional locations associated with the requisition preview.
• AdditionalWorkLocCount: string
  Read Only: true

  Maximum Length: 255

  Count of the additional work locations associated with the requisition preview.
• BusinessJustification: string
  Title: Business Justification

  Read Only: true

  Maximum Length: 255

  Business justification for creating the requisition in the requisition preview.
• Comments: string (byte)
  Title: Comments

  Read Only: true

  Comments provided for creating the requisition in the requisition preview.
• HiringManager: string
  Title: Hiring Manager

  Read Only: true

  Maximum Length: 240

  Name of the hiring manager associated with the requisition in the requisition preview.
• HotJob: string
  Title: Hot Job

  Read Only: true

  Maximum Length: 255

  Hot job indicator on the requisition in the requisition preview.
• Job: string
  Title: Job

  Read Only: true

  Maximum Length: 240

  Job associated to the requisition in the requisition preview.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Location: string
  Title: Location

  Read Only: true

  Maximum Length: 255

  Location defined on the requisition in the requisition preview.
• NumberOfHires: integer (int32)
  Title: Hired Count

  Read Only: true

  Number of hires for the requisition in the requisition preview.
• NumberOfJobApplications: integer
  Title: Number of Job Applications

  Read Only: true

  Number of job applications submitted to the requisition in the requisition preview.
• NumberOfOpenings: string
  Title: Number of Openings

  Read Only: true

  Maximum Length: 255

  Number of openings for the requisition in the requisition preview.
• NumberOfProspects: integer (int32)
  Title: Number of Prospects

  Read Only: true

  Number of prospect candidates associated with the requisition in the requisition preview.
• Organization: string
  Title: Organization

  Read Only: true

  Maximum Length: 255

  Organization associated to the requisition in the requisition preview.
• OtherRequisitionTitle: string
  Title: Other Requisition Title

  Read Only: true

  Maximum Length: 240

  Other requisition title of the requisition in the requisition preview.
• Position: string
  Title: Position

  Read Only: true

  Maximum Length: 750

  Position associated to the requisition in the requisition preview.
• Recruiter: string
  Title: Recruiter

  Read Only: true

  Maximum Length: 240

  Name of the recruiter associated with the requisition in the requisition preview.
• RecruitingType: string
  Title: Recruiting Type

  Read Only: true

  Maximum Length: 255

  Recruiting type defined on the requisition in the requisition preview. For example, professional or hourly.
• RequisitionId: integer (int64)
  Read Only: true

  Requisition ID of the requisition in the requisition preview.
• RequisitionNumber: string
  Title: Requisition Number

  Read Only: true

  Maximum Length: 240

  Requisition number of the requisition in the requisition preview.
• RequisitionStatus: string
  Title: Requisition Status

  Read Only: true

  Maximum Length: 255

  Status of the requisition in the requisition life cycle in the requisition preview.
• RequisitionTitle: string
  Title: Requisition Title

  Read Only: true

  Maximum Length: 240

  Title of the requisition in the requisition preview.
• RequisitionType: string
  Title: Requisition Type

  Read Only: true

  Maximum Length: 255

  Requisition type of the requisition in the requisition preview, either pipeline or standard.
• WorkLocation: string
  Title: Work Location

  Read Only: true

  Maximum Length: 255

  Work location of the requisition in the requisition preview.

{
    "type":"object",
    "properties":{
        "AdditionalWorkLocCount":{
            "maxLength":255,
            "type":"string",
            "description":"Count of the additional work locations associated with the requisition preview.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Organization":{
            "title":"Organization",
            "maxLength":255,
            "type":"string",
            "description":"Organization associated to the requisition in the requisition preview.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Position":{
            "title":"Position",
            "maxLength":750,
            "type":"string",
            "description":"Position associated to the requisition in the requisition preview.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "type":"string",
            "description":"Comments provided for creating the requisition in the requisition preview.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkLocation":{
            "title":"Work Location",
            "maxLength":255,
            "type":"string",
            "description":"Work location of the requisition in the requisition preview.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NumberOfOpenings":{
            "title":"Number of Openings",
            "maxLength":255,
            "type":"string",
            "description":"Number of openings for the requisition in the requisition preview.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AdditionalLocCount":{
            "maxLength":255,
            "type":"string",
            "description":"Count of the additional locations associated with the requisition preview.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "HiringManager":{
            "title":"Hiring Manager",
            "maxLength":240,
            "type":"string",
            "description":"Name of the hiring manager associated with the requisition in the requisition preview.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequisitionNumber":{
            "title":"Requisition Number",
            "maxLength":240,
            "type":"string",
            "description":"Requisition number of the requisition in the requisition preview.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequisitionStatus":{
            "title":"Requisition Status",
            "maxLength":255,
            "type":"string",
            "description":"Status of the requisition in the requisition life cycle in the requisition preview.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NumberOfJobApplications":{
            "title":"Number of Job Applications",
            "type":"integer",
            "description":"Number of job applications submitted to the requisition in the requisition preview.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequisitionId":{
            "type":"integer",
            "description":"Requisition ID of the requisition in the requisition preview.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "NumberOfProspects":{
            "title":"Number of Prospects",
            "type":"integer",
            "description":"Number of prospect candidates associated with the requisition in the requisition preview.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "RequisitionType":{
            "title":"Requisition Type",
            "maxLength":255,
            "type":"string",
            "description":"Requisition type of the requisition in the requisition preview, either pipeline or standard.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecruitingType":{
            "title":"Recruiting Type",
            "maxLength":255,
            "type":"string",
            "description":"Recruiting type defined on the requisition in the requisition preview. For example, professional or hourly.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessJustification":{
            "title":"Business Justification",
            "maxLength":255,
            "type":"string",
            "description":"Business justification for creating the requisition in the requisition preview.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OtherRequisitionTitle":{
            "title":"Other Requisition Title",
            "maxLength":240,
            "type":"string",
            "description":"Other requisition title of the requisition in the requisition preview.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Job":{
            "title":"Job",
            "maxLength":240,
            "type":"string",
            "description":"Job associated to the requisition in the requisition preview.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NumberOfHires":{
            "title":"Hired Count",
            "type":"integer",
            "description":"Number of hires for the requisition in the requisition preview.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "RequisitionTitle":{
            "title":"Requisition Title",
            "maxLength":240,
            "type":"string",
            "description":"Title of the requisition in the requisition preview.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Recruiter":{
            "title":"Recruiter",
            "maxLength":240,
            "type":"string",
            "description":"Name of the recruiter associated with the requisition in the requisition preview.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HotJob":{
            "title":"Hot Job",
            "maxLength":255,
            "type":"string",
            "description":"Hot job indicator on the requisition in the requisition preview.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Location":{
            "title":"Location",
            "maxLength":255,
            "type":"string",
            "description":"Location defined on the requisition in the requisition preview.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

actions

Operation: /hcmRestApi/resources/11.13.18.05/recruitingRACItems/{SubscriberTypeCode}/child/requisitionList/{requisitionListUniqID}/child/actions

Parameters:

• SubscriberTypeCode: $request.path.SubscriberTypeCode
• requisitionListUniqID: $request.path.requisitionListUniqID

The actions resource is the child of the recruitingRACItems resource. It provides a list of job requisition actions that a user can take based on the requisition activity item.

requisitionActionPreviews

Operation: /hcmRestApi/resources/11.13.18.05/recruitingRACItems/{SubscriberTypeCode}/child/requisitionList/{requisitionListUniqID}/child/requisitionActionPreviews

Parameters:

• SubscriberTypeCode: $request.path.SubscriberTypeCode
• requisitionListUniqID: $request.path.requisitionListUniqID

The requisitionActionPreviews resource is the child of the recruitingRACItems resource. It provides a preview displaying data about the requisition based on the action being performed.

requisitionPreviews

Operation: /hcmRestApi/resources/11.13.18.05/recruitingRACItems/{SubscriberTypeCode}/child/requisitionList/{requisitionListUniqID}/child/requisitionPreviews

Parameters:

• SubscriberTypeCode: $request.path.SubscriberTypeCode
• requisitionListUniqID: $request.path.requisitionListUniqID

The requisitionPreviews is the child of the recruitingRACItems resource. It provides a preview of the details of a job requisition.

Back to Top