Jump to

• Request
• Response

Get all job application previews

get

/hcmRestApi/resources/11.13.18.05/recruitingRACItems/{SubscriberTypeCode}/child/jobApplicationList/{ItemId}/child/jobApplicationPreviews

Request

Path Parameters

• ItemId(required): integer(int64)
  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=
• 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=

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
• 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 all job application previews by a primary key.
    Finder Variables
    • SubmissionId; integer; Primary key and SubmissionIdFind used to find all job application previews.
• 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:
  

  • ActiveOnAnotherRequisition; string; Active on another requisition indicator displayed in the job application preview.
  • AreaCode; string; Phone number area code of the candidate displayed in the job application preview.
  • CandidateLocation; string; Candidate location of the candidate displayed in the job application preview.
  • CandidateName; string; Name of the candidate displayed in the job application preview.
  • CandidateNumber; string; Candidate number of the candidate displayed in the job application preview.
  • CandidateType; string; Candidate type of the candidate displayed in the job application preview. For example, internal or external.
  • CountryCodeNumber; string; Phone number country code of the candidate displayed in the job application preview.
  • DaysinStatus; integer; Days in status count of the candidate displayed in the job application preview.
  • DisqualifiedFlag; boolean; Indicates whether the candidate displayed in the job application preview is disqualified or not.
  • EmailAddress; string; Email address of the candidate displayed in the job application preview.
  • InternalFlag; boolean; Indicates whether the candidate displayed in the job application preview is internal or external.
  • LastContacted; integer; Last contacted day count for the candidate displayed in the job application preview.
  • LastContactedMode; string; Last contacted method for the candidate displayed in the job application preview. For example, email or phone call.
  • NextInterviewDate; string; Next interview date for the candidate displayed in the job application preview.
  • PersonId; integer; Person ID of the candidate displayed in the job application preview.
  • PhaseName; string; Phase name of the job application displayed in the job application preview.
  • PhoneNumber; string; Phone number of the candidate displayed in the job application preview.
  • PreScreeningTotalScore; integer; Prescreening question total score for the candidate displayed in the job application preview.
  • QstnrScore; number; Prescreening question maximum possible score for the candidate displayed in the job application preview.
  • ReferredByAgentFlag; boolean; Indicates whether the candidate displayed in job application preview is referred by an agent or not.
  • ReferredFlag; boolean; Indicates whether the candidate displayed in job application preview is referred by an employee or not.
  • RequisitionId; integer; Requisition ID of the job requisition displayed in the job application preview.
  • RequisitionNumber; string; Requisition number the job application preview relates to.
  • RequisitionTitle; string; Requisition title the job application preview relates to.
  • StateName; string; State name of the job application displayed in the job application preview.
  • SubmissionId; integer; Submission ID of the job application displayed in the job application preview.
• 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

• 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-jobApplicationList-jobApplicationPreviews

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":{
        "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."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/recruitingRACItems-jobApplicationList-jobApplicationPreviews-item-response"
            },
            "x-cardinality":"1"
        },
        "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"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object recruitingRACItems-jobApplicationList-jobApplicationPreviews-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/recruitingRACItems-jobApplicationList-jobApplicationPreviews-item-response"
    },
    "x-cardinality":"1"
}

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-jobApplicationList-jobApplicationPreviews-item-response

Type: object

Show Source

• ActiveOnAnotherRequisition: string
  Read Only: true

  Maximum Length: 255

  Active on another requisition indicator displayed in the job application preview.
• AreaCode: string
  Read Only: true

  Maximum Length: 30

  Phone number area code of the candidate displayed in the job application preview.
• CandidateLocation: string
  Title: Candidate Location

  Read Only: true

  Maximum Length: 366

  Candidate location of the candidate displayed in the job application preview.
• CandidateName: string
  Title: Candidate Name

  Read Only: true

  Maximum Length: 240

  Name of the candidate displayed in the job application preview.
• CandidateNumber: string
  Title: Candidate Number

  Read Only: true

  Maximum Length: 30

  Candidate number of the candidate displayed in the job application preview.
• CandidateType: string
  Title: Candidate Type When Applying

  Read Only: true

  Maximum Length: 80

  Candidate type of the candidate displayed in the job application preview. For example, internal or external.
• CountryCodeNumber: string
  Read Only: true

  Maximum Length: 30

  Phone number country code of the candidate displayed in the job application preview.
• DaysinStatus: integer
  Title: Days in Status

  Read Only: true

  Days in status count of the candidate displayed in the job application preview.
• DisqualifiedFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the candidate displayed in the job application preview is disqualified or not.
• EmailAddress: string
  Title: Candidate Email

  Read Only: true

  Maximum Length: 240

  Email address of the candidate displayed in the job application preview.
• InternalFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the candidate displayed in the job application preview is internal or external.
• LastContacted: integer
  Title: Last Contacted

  Read Only: true

  Last contacted day count for the candidate displayed in the job application preview.
• LastContactedMode: string
  Read Only: true

  Maximum Length: 255

  Last contacted method for the candidate displayed in the job application preview. For example, email or phone call.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NextInterviewDate: string (date-time)
  Title: Most Recent Interview Date

  Read Only: true

  Next interview date for the candidate displayed in the job application preview.
• PersonId: integer (int64)
  Read Only: true

  Person ID of the candidate displayed in the job application preview.
• PhaseName: string
  Title: Job Application Status

  Read Only: true

  Maximum Length: 240

  Phase name of the job application displayed in the job application preview.
• PhoneNumber: string
  Title: Candidate Phone Number

  Read Only: true

  Maximum Length: 60

  Phone number of the candidate displayed in the job application preview.
• PreScreeningTotalScore: integer (int64)
  Read Only: true

  Prescreening question total score for the candidate displayed in the job application preview.
• QstnrScore: number
  Title: Prescreening Score

  Read Only: true

  Prescreening question maximum possible score for the candidate displayed in the job application preview.
• ReferredByAgentFlag: boolean
  Read Only: true

  Maximum Length: 255

  Indicates whether the candidate displayed in job application preview is referred by an agent or not.
• ReferredFlag: boolean
  Read Only: true

  Maximum Length: 255

  Indicates whether the candidate displayed in job application preview is referred by an employee or not.
• RequisitionId: integer (int64)
  Read Only: true

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

  Read Only: true

  Maximum Length: 240

  Requisition number the job application preview relates to.
• RequisitionTitle: string
  Title: Requisition Title

  Read Only: true

  Maximum Length: 240

  Requisition title the job application preview relates to.
• StateName: string
  Read Only: true

  Maximum Length: 240

  State name of the job application displayed in the job application preview.
• SubmissionId: integer
  Read Only: true

  Submission ID of the job application displayed in the job application preview.

{
    "type":"object",
    "properties":{
        "ActiveOnAnotherRequisition":{
            "maxLength":255,
            "type":"string",
            "description":"Active on another requisition indicator displayed in the job application preview.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AreaCode":{
            "maxLength":30,
            "type":"string",
            "description":"Phone number area code of the candidate displayed in the job application preview.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CandidateLocation":{
            "title":"Candidate Location",
            "maxLength":366,
            "type":"string",
            "description":"Candidate location of the candidate displayed in the job application preview.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CandidateName":{
            "title":"Candidate Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the candidate displayed in the job application preview.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CandidateNumber":{
            "title":"Candidate Number",
            "maxLength":30,
            "type":"string",
            "description":"Candidate number of the candidate displayed in the job application preview.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CandidateType":{
            "title":"Candidate Type When Applying",
            "maxLength":80,
            "type":"string",
            "description":"Candidate type of the candidate displayed in the job application preview. For example, internal or external.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CountryCodeNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Phone number country code of the candidate displayed in the job application preview.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DaysinStatus":{
            "title":"Days in Status",
            "type":"integer",
            "description":"Days in status count of the candidate displayed in the job application preview.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DisqualifiedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the candidate displayed in the job application preview is disqualified or not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Candidate Email",
            "maxLength":240,
            "type":"string",
            "description":"Email address of the candidate displayed in the job application preview.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InternalFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the candidate displayed in the job application preview is internal or external.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastContacted":{
            "title":"Last Contacted",
            "type":"integer",
            "description":"Last contacted day count for the candidate displayed in the job application preview.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastContactedMode":{
            "maxLength":255,
            "type":"string",
            "description":"Last contacted method for the candidate displayed in the job application preview. For example, email or phone call.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NextInterviewDate":{
            "title":"Most Recent Interview Date",
            "type":"string",
            "description":"Next interview date for the candidate displayed in the job application preview.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"Person ID of the candidate displayed in the job application preview.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PhaseName":{
            "title":"Job Application Status",
            "maxLength":240,
            "type":"string",
            "description":"Phase name of the job application displayed in the job application preview.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PhoneNumber":{
            "title":"Candidate Phone Number",
            "maxLength":60,
            "type":"string",
            "description":"Phone number of the candidate displayed in the job application preview.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PreScreeningTotalScore":{
            "type":"integer",
            "description":"Prescreening question total score for the candidate displayed in the job application preview.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":255
            },
            "x-queryable":true
        },
        "QstnrScore":{
            "title":"Prescreening Score",
            "type":"number",
            "description":"Prescreening question maximum possible score for the candidate displayed in the job application preview.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "scale":2
            },
            "x-queryable":true
        },
        "ReferredByAgentFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Indicates whether the candidate displayed in job application preview is referred by an agent or not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReferredFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Indicates whether the candidate displayed in job application preview is referred by an employee or not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequisitionId":{
            "type":"integer",
            "description":"Requisition ID of the job requisition displayed in the job application preview.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RequisitionNumber":{
            "title":"Requisition Number",
            "maxLength":240,
            "type":"string",
            "description":"Requisition number the job application preview relates to.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequisitionTitle":{
            "title":"Requisition Title",
            "maxLength":240,
            "type":"string",
            "description":"Requisition title the job application preview relates to.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StateName":{
            "maxLength":240,
            "type":"string",
            "description":"State name of the job application displayed in the job application preview.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmissionId":{
            "type":"integer",
            "description":"Submission ID of the job application displayed in the job application 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"
            }
        }
    }
}

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."
        }
    }
}

Back to Top