Jump to

• Request
• Response

Get the details of all job distributions

get

/hcmRestApi/resources/11.13.18.05/jobDistributionDetails

Request

Query Parameters

• effectiveDate: string
  This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
• 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 the details of the job distribution using RowFinder
    Finder Variables
  • RowFinder Finds the details of the job distribution using RowFinder
    Finder Variables
    • bPartnerId; string;
    • bReqLang; string;
    • bReqNumber; string; Finds the details of the job distribution using RowFinder and the bReqNumber; string; variable
• 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:
  

  • ContractType; string; Type of contract signed with the candidate.
  • DomesticTravelRequired; string; Indicates if domestic travel is required for the candidate.
  • ExternalContactEmail; string; External contact email of the candidate.
  • ExternalContactName; string; External contact name of the candidate.
  • InternationalTravelRequired; string; Indicates if international travel is required for the candidate.
  • JobFamilyCode; string; Code assigned to the job family.
  • JobSchedule; string; Schedule of the job.
  • JobShift; string; Shift of the job.
  • JobType; string; Type of job.
  • OrganizationDisplayName; string; Display name of the organization.
  • PartnerId; string; ID assigned to the partner.
  • PostingEndDate; string; End date of the job posting.
  • PostingStartDate; string; Start date of the job posting.
  • PostingStatus; string; Status of the job posting.
  • PrimaryLocationCountryCode; string; Country code of the primary location of the job posting.
  • PrimaryLocationLevelTwoCode; string; Second level code of the primary location of the job posting.
  • PrimaryWorkLocationPostalCode; string; Postal code of the primary work location of the job posting.
  • RequisitionNumber; string; Requisition number of the job posting.
  • StudyLevel; string; Educational qualification of the candidate.
  • WorkplaceTypeCode; string; Type of workplace of the job requisition.
• 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

• 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 : jobDistributionDetails

Type: object

Show Source

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

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"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."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/jobDistributionDetails-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object jobDistributionDetails-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/jobDistributionDetails-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 : jobDistributionDetails-item-response

Type: object

Show Source

• ContractType: string
  Read Only: true

  Maximum Length: 30

  Type of contract signed with the candidate.
• DomesticTravelRequired: string
  Read Only: true

  Maximum Length: 30

  Indicates if domestic travel is required for the candidate.
• ExternalContactEmail: string
  Read Only: true

  Maximum Length: 240

  External contact email of the candidate.
• ExternalContactName: string
  Read Only: true

  Maximum Length: 240

  External contact name of the candidate.
• InternationalTravelRequired: string
  Read Only: true

  Maximum Length: 30

  Indicates if international travel is required for the candidate.
• JobFamilyCode: string
  Read Only: true

  Maximum Length: 240

  Code assigned to the job family.
• JobSchedule: string
  Read Only: true

  Maximum Length: 30

  Schedule of the job.
• JobShift: string
  Read Only: true

  Maximum Length: 30

  Shift of the job.
• JobType: string
  Title: Visibility

  Read Only: true

  Maximum Length: 30

  Type of job.
• links: array Links
  Title: Links

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

  Read Only: true

  Maximum Length: 240

  Display name of the organization.
• PartnerId: string
  Read Only: true

  ID assigned to the partner.
• PostingEndDate: string (date-time)
  Title: End Date

  Read Only: true

  End date of the job posting.
• PostingStartDate: string (date-time)
  Title: Start Date

  Read Only: true

  Start date of the job posting.
• PostingStatus: string
  Title: Posting Status

  Read Only: true

  Maximum Length: 30

  Status of the job posting.
• PrimaryLocationCountryCode: string
  Read Only: true

  Maximum Length: 2

  Country code of the primary location of the job posting.
• PrimaryLocationLevelTwoCode: string
  Read Only: true

  Maximum Length: 255

  Second level code of the primary location of the job posting.
• PrimaryWorkLocationPostalCode: string
  Title: Postal Code

  Read Only: true

  Maximum Length: 30

  Postal code of the primary work location of the job posting.
• requisitionAdditionalAttributes: array Recruiting Requisition Additional Attributes
  Title: Recruiting Requisition Additional Attributes

  The requisitionAdditionalAttributes resource provides the additional attributes of the posted job requisition. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
• requisitionLanguages: array Requisition Languages
  Title: Requisition Languages

  The requisitionLanguages resource is a child of jobDistributionDetails. It includes the details of the languages mentioned in the job description.
• RequisitionNumber: string
  Read Only: true

  Maximum Length: 240

  Requisition number of the job posting.
• skills: array Requisition Skills
  Title: Requisition Skills

  The skills resource provides details about the skills included in the job requisition.
• StudyLevel: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Educational qualification of the candidate.
• WorkplaceTypeCode: string
  Read Only: true

  Maximum Length: 30

  Type of workplace of the job requisition.

{
    "type":"object",
    "properties":{
        "OrganizationDisplayName":{
            "title":"Organization",
            "maxLength":240,
            "type":"string",
            "description":"Display name of the organization.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExternalContactName":{
            "maxLength":240,
            "type":"string",
            "description":"External contact name of the candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryLocationCountryCode":{
            "maxLength":2,
            "type":"string",
            "description":"Country code of the primary location of the job posting.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkplaceTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Type of workplace of the job requisition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryLocationLevelTwoCode":{
            "maxLength":255,
            "type":"string",
            "description":"Second level code of the primary location of the job posting.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PostingStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Start date of the job posting.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartnerId":{
            "type":"string",
            "description":"ID assigned to the partner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExternalContactEmail":{
            "maxLength":240,
            "type":"string",
            "description":"External contact email of the candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "requisitionLanguages":{
            "title":"Requisition Languages",
            "type":"array",
            "description":"The requisitionLanguages resource is a child of jobDistributionDetails. It includes the details of the languages mentioned in the job description.",
            "items":{
                "$ref":"#/components/schemas/jobDistributionDetails-requisitionLanguages-item-response"
            }
        },
        "JobShift":{
            "maxLength":30,
            "type":"string",
            "description":"Shift of the job.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequisitionNumber":{
            "maxLength":240,
            "type":"string",
            "description":"Requisition number of the job posting.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InternationalTravelRequired":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates if international travel is required for the candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryWorkLocationPostalCode":{
            "title":"Postal Code",
            "maxLength":30,
            "type":"string",
            "description":"Postal code of the primary work location of the job posting.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "skills":{
            "title":"Requisition Skills",
            "type":"array",
            "description":"The skills resource provides details about the skills included in the job requisition.",
            "items":{
                "$ref":"#/components/schemas/jobDistributionDetails-skills-item-response"
            }
        },
        "DomesticTravelRequired":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates if domestic travel is required for the candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "JobType":{
            "title":"Visibility",
            "maxLength":30,
            "type":"string",
            "description":"Type of job.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "JobSchedule":{
            "maxLength":30,
            "type":"string",
            "description":"Schedule of the job.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PostingEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"End date of the job posting.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PostingStatus":{
            "title":"Posting Status",
            "maxLength":30,
            "type":"string",
            "description":"Status of the job posting.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "JobFamilyCode":{
            "maxLength":240,
            "type":"string",
            "description":"Code assigned to the job family.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "requisitionAdditionalAttributes":{
            "title":"Recruiting Requisition Additional Attributes",
            "type":"array",
            "description":"The requisitionAdditionalAttributes resource provides the additional attributes of the posted job requisition. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.",
            "items":{
                "$ref":"#/components/schemas/jobDistributionDetails-requisitionAdditionalAttributes-item-response"
            }
        },
        "StudyLevel":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Educational qualification of the candidate.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContractType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of contract signed with the candidate.",
            "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"
            }
        }
    }
}

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 : Recruiting Requisition Additional Attributes

Type: array

Title: Recruiting Requisition Additional Attributes

The requisitionAdditionalAttributes resource provides the additional attributes of the posted job requisition. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.

Show Source

• Array of: object jobDistributionDetails-requisitionAdditionalAttributes-item-response

{
    "title":"Recruiting Requisition Additional Attributes",
    "type":"array",
    "description":"The requisitionAdditionalAttributes resource provides the additional attributes of the posted job requisition. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.",
    "items":{
        "$ref":"#/components/schemas/jobDistributionDetails-requisitionAdditionalAttributes-item-response"
    }
}

Nested Schema : Requisition Languages

Type: array

Title: Requisition Languages

The requisitionLanguages resource is a child of jobDistributionDetails. It includes the details of the languages mentioned in the job description.

Show Source

• Array of: object jobDistributionDetails-requisitionLanguages-item-response

{
    "title":"Requisition Languages",
    "type":"array",
    "description":"The requisitionLanguages resource is a child of jobDistributionDetails. It includes the details of the languages mentioned in the job description.",
    "items":{
        "$ref":"#/components/schemas/jobDistributionDetails-requisitionLanguages-item-response"
    }
}

Nested Schema : Requisition Skills

Type: array

Title: Requisition Skills

The skills resource provides details about the skills included in the job requisition.

Show Source

• Array of: object jobDistributionDetails-skills-item-response

{
    "title":"Requisition Skills",
    "type":"array",
    "description":"The skills resource provides details about the skills included in the job requisition.",
    "items":{
        "$ref":"#/components/schemas/jobDistributionDetails-skills-item-response"
    }
}

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 : jobDistributionDetails-requisitionAdditionalAttributes-item-response

Type: object

Show Source

• AttributeName: string
  Read Only: true

  Maximum Length: 255

  Attribute name of the additional attribute.
• AttributeType: string
  Read Only: true

  Maximum Length: 255

  Attribute type of the additional attribute.
• FlexContextCode: string
  Read Only: true

  Maximum Length: 255

  Flexfield context code of the additional attribute.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LOVFlag: boolean
  Read Only: true

  Maximum Length: 255

  List of value of the additional attribute.
• Type: string
  Read Only: true

  Maximum Length: 255

  Type of the additional attribute.
• Value: string
  Read Only: true

  Maximum Length: 255

  Value of the additional attribute.

{
    "type":"object",
    "properties":{
        "Type":{
            "maxLength":255,
            "type":"string",
            "description":"Type of the additional attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FlexContextCode":{
            "maxLength":255,
            "type":"string",
            "description":"Flexfield context code of the additional attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AttributeType":{
            "maxLength":255,
            "type":"string",
            "description":"Attribute type of the additional attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Value":{
            "maxLength":255,
            "type":"string",
            "description":"Value of the additional attribute.",
            "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"
            }
        },
        "AttributeName":{
            "maxLength":255,
            "type":"string",
            "description":"Attribute name of the additional attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LOVFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"List of value of the additional attribute.",
            "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 : jobDistributionDetails-requisitionLanguages-item-response

Type: object

Show Source

• ApplyURL: string
  Read Only: true

  The URL for applying in the requisition languages.
• DefaultLanguageFlag: boolean
  Read Only: true

  Maximum Length: 1

  Default language of the requisition.
• EmployerDescriptionStr: string
  Read Only: true

  Description of the employer in the requisition languages.
• ExternalDescription: string
  Description of the external candidate in the requisition languages.
• ExternalDescriptionHtml: string
  HTML description for the external candidate in the requisition languages.
• ExternalQualificationsHTML: string
  HTML qualifications for the external candidate in the requisition languages.
• ExternalResponsibilitiesHTML: string
  HTML responsibilities for the external candidate in the requisition languages.
• JobFamily: string
  Read Only: true

  Maximum Length: 240

  Details of the job family in the requisition languages.
• LanguageCode: string
  Code assigned to the language in the requisition languages.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• media: array Requisition Media
  Title: Requisition Media

  The media resource is a child of requisitionLanguages. It includes the details of the type of media used in the job distribution.
• OrganizationDescriptionStr: string
  Read Only: true

  Description of the organization in the requisition languages.
• OrganizationNameML: string
  Title: Organization

  Read Only: true

  Maximum Length: 240

  Display name of the organization in the requisition languages.
• PrimaryLocation: string
  Read Only: true

  Primary job location mentioned in the requisition languages.
• PrimaryLocationCountryName: string
  Country name of the primary location in the requisition languages.
• PrimaryLocationLevelThreeName: string
  Read Only: true

  Maximum Length: 255

  Third level name of the primary location in the requisition languages.
• PrimaryLocationLevelTwoName: string
  Read Only: true

  Maximum Length: 255

  Second level name of the primary location in the requisition languages.
• PrimaryWorkLocationCity: string
  Title: Town or City

  Read Only: true

  Maximum Length: 30

  City of the primary work location in the requisition languages.
• secondaryLocations: array Secondary Locations
  Title: Secondary Locations

  The secondaryLocations resource includes all the details of the secondary preferred location for the job distribution.
• ShortDescription: string
  Short description of the requisition languages.
• skills: array Requisition Skills
  Title: Requisition Skills

  The skills resource provides details about the skills included in the job requisition.
• StudyLevelML: string
  Read Only: true

  Maximum Length: 80

  Educational qualification needed in the requisition languages.
• Title: string
  Read Only: true

  Maximum Length: 240

  Title of the requisition languages.

{
    "type":"object",
    "properties":{
        "ExternalDescriptionHtml":{
            "type":"string",
            "description":"HTML description for the external candidate in the requisition languages.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ExternalDescHtml"
                ]
            },
            "x-queryable":true
        },
        "secondaryLocations":{
            "title":"Secondary Locations",
            "type":"array",
            "description":"The secondaryLocations resource includes all the details of the secondary preferred location for the job distribution.",
            "items":{
                "$ref":"#/components/schemas/jobDistributionDetails-requisitionLanguages-secondaryLocations-item-response"
            }
        },
        "PrimaryLocation":{
            "type":"string",
            "description":"Primary job location mentioned in the requisition languages.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryLocationLevelTwoName":{
            "maxLength":255,
            "type":"string",
            "description":"Second level name of the primary location in the requisition languages.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryLocationCountryName":{
            "type":"string",
            "description":"Country name of the primary location in the requisition languages.",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalResponsibilitiesHTML":{
            "type":"string",
            "description":"HTML responsibilities for the external candidate in the requisition languages.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ExternalRespHtml"
                ]
            },
            "x-queryable":true
        },
        "OrganizationDescriptionStr":{
            "type":"string",
            "description":"Description of the organization in the requisition languages.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EmployerDescriptionStr":{
            "type":"string",
            "description":"Description of the employer in the requisition languages.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Title":{
            "maxLength":240,
            "type":"string",
            "description":"Title of the requisition languages.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "JobFamily":{
            "maxLength":240,
            "type":"string",
            "description":"Details of the job family in the requisition languages.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "media":{
            "title":"Requisition Media",
            "type":"array",
            "description":"The media resource is a child of requisitionLanguages. It includes the details of the type of media used in the job distribution.",
            "items":{
                "$ref":"#/components/schemas/jobDistributionDetails-requisitionLanguages-media-item-response"
            }
        },
        "ApplyURL":{
            "type":"string",
            "description":"The URL for applying in the requisition languages.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StudyLevelML":{
            "maxLength":80,
            "type":"string",
            "description":"Educational qualification needed in the requisition languages.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ShortDescription":{
            "type":"string",
            "description":"Short description of the requisition languages.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ExternalShortDesc"
                ]
            },
            "x-queryable":true
        },
        "skills":{
            "title":"Requisition Skills",
            "type":"array",
            "description":"The skills resource provides details about the skills included in the job requisition.",
            "items":{
                "$ref":"#/components/schemas/jobDistributionDetails-requisitionLanguages-skills-item-response"
            }
        },
        "LanguageCode":{
            "type":"string",
            "description":"Code assigned to the language in the requisition languages.",
            "nullable":true,
            "x-queryable":true
        },
        "DefaultLanguageFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Default language of the requisition.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "IsBaseFlag"
                ]
            },
            "x-queryable":true
        },
        "OrganizationNameML":{
            "title":"Organization",
            "maxLength":240,
            "type":"string",
            "description":"Display name of the organization in the requisition languages.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ExternalQualificationsHTML":{
            "type":"string",
            "description":"HTML qualifications for the external candidate in the requisition languages.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ExternalQualHtml"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ExternalDescription":{
            "type":"string",
            "description":"Description of the external candidate in the requisition languages.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ExternalDesc"
                ]
            },
            "x-queryable":true
        },
        "PrimaryWorkLocationCity":{
            "title":"Town or City",
            "maxLength":30,
            "type":"string",
            "description":"City of the primary work location in the requisition languages.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryLocationLevelThreeName":{
            "maxLength":255,
            "type":"string",
            "description":"Third level name of the primary location in the requisition languages.",
            "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 : Requisition Media

Type: array

Title: Requisition Media

The media resource is a child of requisitionLanguages. It includes the details of the type of media used in the job distribution.

Show Source

• Array of: object jobDistributionDetails-requisitionLanguages-media-item-response

{
    "title":"Requisition Media",
    "type":"array",
    "description":"The media resource is a child of requisitionLanguages. It includes the details of the type of media used in the job distribution.",
    "items":{
        "$ref":"#/components/schemas/jobDistributionDetails-requisitionLanguages-media-item-response"
    }
}

Nested Schema : Secondary Locations

Type: array

Title: Secondary Locations

The secondaryLocations resource includes all the details of the secondary preferred location for the job distribution.

Show Source

• Array of: object jobDistributionDetails-requisitionLanguages-secondaryLocations-item-response

{
    "title":"Secondary Locations",
    "type":"array",
    "description":"The secondaryLocations resource includes all the details of the secondary preferred location for the job distribution.",
    "items":{
        "$ref":"#/components/schemas/jobDistributionDetails-requisitionLanguages-secondaryLocations-item-response"
    }
}

Nested Schema : Requisition Skills

Type: array

Title: Requisition Skills

The skills resource provides details about the skills included in the job requisition.

Show Source

• Array of: object jobDistributionDetails-requisitionLanguages-skills-item-response

{
    "title":"Requisition Skills",
    "type":"array",
    "description":"The skills resource provides details about the skills included in the job requisition.",
    "items":{
        "$ref":"#/components/schemas/jobDistributionDetails-requisitionLanguages-skills-item-response"
    }
}

Nested Schema : jobDistributionDetails-requisitionLanguages-media-item-response

Type: object

Show Source

• Id: integer (int64)
  Read Only: true

  ID assigned to the media used in requisition languages.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Priority: integer (int32)
  Read Only: true

  Priority assigned to the media used in requisition languages.
• RequisitionMediaLinkId: integer (int64)
  Read Only: true

  Priority assigned to the media used in requisition languages.
• ThumbURL: string
  Read Only: true

  Maximum Length: 1000

  Thumb URL assigned to the media used in requisition languages.
• Title: string
  Read Only: true

  Maximum Length: 240

  Title assigned to the media used in requisition languages.
• Type: string
  Title: Lookup Code

  Read Only: true

  Maximum Length: 30

  Type assigned to the media used in requisition languages.
• URL: string
  Read Only: true

  Maximum Length: 1000

  URL of the media used in the job application.

{
    "type":"object",
    "properties":{
        "Type":{
            "title":"Lookup Code",
            "maxLength":30,
            "type":"string",
            "description":"Type assigned to the media used in requisition languages.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Priority":{
            "type":"integer",
            "description":"Priority assigned to the media used in requisition languages.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ThumbURL":{
            "maxLength":1000,
            "type":"string",
            "description":"Thumb URL assigned to the media used in requisition languages.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Title":{
            "maxLength":240,
            "type":"string",
            "description":"Title assigned to the media used in requisition languages.",
            "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"
            }
        },
        "Id":{
            "type":"integer",
            "description":"ID assigned to the media used in requisition languages.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RequisitionMediaLinkId":{
            "type":"integer",
            "description":"Priority assigned to the media used in requisition languages.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "URL":{
            "maxLength":1000,
            "type":"string",
            "description":"URL of the media used in the job application.",
            "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 : jobDistributionDetails-requisitionLanguages-secondaryLocations-item-response

Type: object

Show Source

• GeographyNodeId: integer (int64)
  Title: Primary Location

  Read Only: true

  Geography node ID of the secondary location.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Location: string
  Read Only: true

  Location of requisitions.

{
    "type":"object",
    "properties":{
        "GeographyNodeId":{
            "title":"Primary Location",
            "type":"integer",
            "description":"Geography node ID of the secondary location.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Location":{
            "type":"string",
            "description":"Location of requisitions.",
            "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 : jobDistributionDetails-requisitionLanguages-skills-item-response

Type: object

Show Source

• Importance: integer (int64)
  Read Only: true

  High importance indicator of a skill for the posted requisition.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MinimumSkillLevel: string
  Read Only: true

  Maximum Length: 2000

  Minimum level of a skill for the posted requisition.
• MinimumYearsExperience: integer (int64)
  Read Only: true

  Minimum years of experience for the posted requisition.
• Required: string
  Read Only: true

  Maximum Length: 30

  Required indicator of a skill for the posted requisition.
• SectionName: string
  Read Only: true

  Maximum Length: 240

  Section name of a skill for the posted requisition.
• Skill: string
  Read Only: true

  Maximum Length: 700

  Skill of the posted requisition.
• SkillType: string
  Read Only: true

  Maximum Length: 30

  Skill type of a skill for the posted requisition.

{
    "type":"object",
    "properties":{
        "Importance":{
            "type":"integer",
            "description":"High importance indicator of a skill for the posted requisition.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Skill":{
            "maxLength":700,
            "type":"string",
            "description":"Skill of the posted requisition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Required":{
            "maxLength":30,
            "type":"string",
            "description":"Required indicator of a skill for the posted requisition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MinimumSkillLevel":{
            "maxLength":2000,
            "type":"string",
            "description":"Minimum level of a skill for the posted requisition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MinimumYearsExperience":{
            "type":"integer",
            "description":"Minimum years of experience for the posted requisition.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SkillType":{
            "maxLength":30,
            "type":"string",
            "description":"Skill type of a skill for the posted requisition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SectionName":{
            "maxLength":240,
            "type":"string",
            "description":"Section name of a skill for the posted 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 : jobDistributionDetails-skills-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SectionName: string
  Read Only: true

  Maximum Length: 240

  Name of the section to which a skill belongs.
• Skill: string
  Read Only: true

  Maximum Length: 255

  Name of the skill.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Skill":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the skill.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SectionName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the section to which a skill belongs.",
            "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"
    }
}

Back to Top