Jump to

• Request
• Response

Get a job application action preview

get

/hcmRestApi/resources/11.13.18.05/recruitingRACItems/{SubscriberTypeCode}/child/jobApplicationList/{ItemId}/child/jobApplicationActionPreviews/{ItemId2}

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=
• ItemId2(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
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context: 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-jobApplicationActionPreviews-item-response

Type: object

Show Source

• ActiveOnAnotherRequisition: string
  Read Only: true

  Maximum Length: 255

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

  Maximum Length: 30

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

  Read Only: true

  Maximum Length: 366

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

  Read Only: true

  Maximum Length: 240

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

  Read Only: true

  Maximum Length: 30

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

  Read Only: true

  Maximum Length: 80

  Candidate type of the candidate displayed in the job application action preview.
• CountryCodeNumber: string
  Read Only: true

  Maximum Length: 30

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

  Current phase identifier of the job application displayed in the job application action preview.
• DaysinStatus: integer
  Title: Days in Status

  Read Only: true

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

  Maximum Length: 1

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

  Read Only: true

  Maximum Length: 240

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

  Maximum Length: 1

  Indicates whether the candidate displayed in the job application action preview is internal or external.
• ItemId: integer (int64)
  Read Only: true

  Unique identifier for the job application action activity item.
• LastContacted: integer
  Title: Last Contacted

  Read Only: true

  Date and time when the candidate was last contacted, displayed in the job application action preview.
• LastContactedMode: string
  Read Only: true

  Maximum Length: 255

  Last contacted method for the candidate displayed in the job application action preview.
• 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 action preview.
• ObjectId: integer (int64)
  Read Only: true

  Object identifier of the activity for the job application action preview.
• PersonId: integer (int64)
  Read Only: true

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

  Read Only: true

  Maximum Length: 240

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

  Read Only: true

  Maximum Length: 60

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

  Prescreening question total score displayed in the candidate for job application action preview.
• ProcessId: integer (int64)
  Read Only: true

  Process identifier for the job application action preview.
• QstnrScore: number
  Title: Prescreening Score

  Read Only: true

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

  Maximum Length: 255

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

  Maximum Length: 255

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

  Requisition identifier of the job requisition for the job application action preview.
• RequisitionNumber: string
  Title: Requisition Number

  Read Only: true

  Maximum Length: 240

  Requisition number of the job requisition displayed in the job application action preview.
• RequisitionTitle: string
  Title: Requisition Title

  Read Only: true

  Maximum Length: 240

  Requisition title of the job requisition displayed in the job application action preview.
• StateName: string
  Read Only: true

  Maximum Length: 240

  State of the job application displayed in the job application action preview.
• Subject: string
  Read Only: true

  Maximum Length: 30

  Subject associated with the job application action preview.
• SubjectType: string
  Read Only: true

  Maximum Length: 30

  Subject type associated with the job application action preview.
• SubmissionId: integer
  Read Only: true

  Submission ID for the job application action preview.
• SubscriberRuleCode: string
  Read Only: true

  Maximum Length: 256

  Subscriber rule code for the job application action activity item.
• UpdatedExpirationDate: string (date-time)
  Title: New Expiration Date

  Read Only: true

  Updated expiration date for the job application action activity item.

{
    "type":"object",
    "properties":{
        "LastContacted":{
            "title":"Last Contacted",
            "type":"integer",
            "description":"Date and time when the candidate was last contacted, displayed in the job application action 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 action preview.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QstnrScore":{
            "title":"Prescreening Score",
            "type":"number",
            "description":"Prescreening question maximum possible score for the candidate displayed in the job application action preview.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "scale":2
            },
            "x-queryable":true
        },
        "DisqualifiedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the candidate displayed in the job application action preview is disqualified.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StateName":{
            "maxLength":240,
            "type":"string",
            "description":"State of the job application displayed in the job application action preview.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PhaseName":{
            "title":"Job Application Status",
            "maxLength":240,
            "type":"string",
            "description":"Phase of the job application displayed in the job application action preview.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemId":{
            "type":"integer",
            "description":"Unique identifier for the job application action activity item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RequisitionNumber":{
            "title":"Requisition Number",
            "maxLength":240,
            "type":"string",
            "description":"Requisition number of the job requisition displayed in the job application action preview.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequisitionId":{
            "type":"integer",
            "description":"Requisition identifier of the job requisition for the job application action preview.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "NextInterviewDate":{
            "title":"Most Recent Interview Date",
            "type":"string",
            "description":"Next interview date for the candidate displayed in the job application action preview.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReferredFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Indicates whether the candidate is referred by an employee, displayed in the job application action preview.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubjectType":{
            "maxLength":30,
            "type":"string",
            "description":"Subject type associated with the job application action preview.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubscriberRuleCode":{
            "maxLength":256,
            "type":"string",
            "description":"Subscriber rule code for the job application action activity item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastContactedMode":{
            "maxLength":255,
            "type":"string",
            "description":"Last contacted method for the candidate displayed in the job application action 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"
            }
        },
        "CurrentPhaseId":{
            "type":"integer",
            "description":"Current phase identifier of the job application displayed in the job application action preview.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CandidateNumber":{
            "title":"Candidate Number",
            "maxLength":30,
            "type":"string",
            "description":"Candidate number of the candidate displayed in the job application action preview.",
            "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 action preview.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectId":{
            "type":"integer",
            "description":"Object identifier of the activity for the job application action preview.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PreScreeningTotalScore":{
            "type":"integer",
            "description":"Prescreening question total score displayed in the candidate for job application action 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 action preview.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UpdatedExpirationDate":{
            "title":"New Expiration Date",
            "type":"string",
            "description":"Updated expiration date for the job application action activity item.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InternalFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the candidate displayed in the job application action preview is internal or external.",
            "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 action preview.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReferredByAgentFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Indicates whether the candidate is referred by an agent, displayed in the job application action preview.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Subject":{
            "maxLength":30,
            "type":"string",
            "description":"Subject associated with the job application action preview.",
            "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 action preview.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"Person identifier of the candidate displayed in the job application action preview.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CandidateName":{
            "title":"Candidate Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the candidate displayed in the job application action preview.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActiveOnAnotherRequisition":{
            "maxLength":255,
            "type":"string",
            "description":"Active on another requisition indicator displayed in the job application action preview.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmissionId":{
            "type":"integer",
            "description":"Submission ID for the job application action 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 action 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 action preview.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessId":{
            "type":"integer",
            "description":"Process identifier for the job application action preview.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RequisitionTitle":{
            "title":"Requisition Title",
            "maxLength":240,
            "type":"string",
            "description":"Requisition title of the job requisition displayed in the job application action 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"
    }
}

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