Get a job application draft

get

/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}

Request

Path Parameters
  • 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
  • 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>
  • 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).
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : recruitingICEJobApplicationDrafts-item-response
Type: object
Show Source
  • Maximum Length: 255
    Title of the action associated with the internal candidate experience application draft.
  • Maximum Length: 255
    Plain string value of the attachment name in the internal candidate experience application draft.
  • Attachments
    Title: Attachments
    The attachments resource is used to view, create, and update attachments.
  • Maximum Length: 255
    Plain string value of the content of the internal candidate experience application draft.
  • Plain string value of the internal candidate experience draft identifier.
  • Links
  • Plain string value of the person identifier associated with internal candidate experience application draft.
  • Plain string value of the questionnaire version number associated with internal candidate experience application draft.
  • Plain string value of questionnaire identifier associated with internal candidate experience application draft.
  • Questionnaire Responses
    Title: Questionnaire Responses
    The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.
  • Maximum Length: 255
    Plain string value of the requisition number associated with internal candidate experience application draft.
  • Maximum Length: 255
    Plain string value of requisition title associated with internal candidate experience application draft
  • Maximum Length: 255
    Plain string value of the subscriber code associated with the internal candidate experience application draft.
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Questionnaire Responses
Type: array
Title: Questionnaire Responses
The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.
Show Source
Nested Schema : recruitingICEJobApplicationDrafts-attachments-item-response
Type: object
Show Source
Nested Schema : recruitingICEJobApplicationDrafts-questionnaireResponses-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Question Responses
Type: array
Title: Question Responses
The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.
Show Source
Nested Schema : recruitingICEJobApplicationDrafts-questionnaireResponses-questionnaireAttachments-item-response
Type: object
Show Source
Nested Schema : recruitingICEJobApplicationDrafts-questionnaireResponses-questionResponses-item-response
Type: object
Show Source
  • Title: Answer Code
    Read Only: true
    Maximum Length: 240
    The answer code that a participant chose when responding to a single choice question.
  • Title: Answer Code List
    Concatenated list of answer choices, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.
  • Title: Comments
    Maximum Length: 4000
    Additional comments provided by the participant when responding to a question.
  • Title: Answer
    Attachment provided by the participant when responding to a question.
  • Title: Answer List
    Maximum Length: 2000
    Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.
  • Title: Answer Short Description
    Read Only: true
    Maximum Length: 240
    Text of the answer chosen by a participant when responding to a single choice question.
  • Title: Answer Short Description
    Read Only: true
    Concatenated list of answer texts, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.
  • Title: Choice List Code
    Concatenated list of answer codes, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.
  • Title: Choice List
    Maximum Length: 2000
    Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.
  • Title: Choice Short Description
    Read Only: true
    Concatenated list of answer texts, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    User who created the question response.
  • Title: Creation Date
    Read Only: true
    Date on which the question response was created.
  • Title: Last Update Date
    Read Only: true
    Date on which the question response was updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    User who last updated the question response.
  • Links
  • Title: Question Answer Id
    Surrogate identifier of the answer that a participant chose when responding to a single choice question.
  • Title: Question Code
    Maximum Length: 240
    Alphanumeric value that uniquely identifies a question defined for a subscriber.
  • Title: Question Id
    Surrogate identifier for the question.
  • Title: Questionnaire Question Id
    Surrogate identifier for the question in a questionnaire.
  • Question Response Attachments
    Title: Question Response Attachments
    The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
  • Title: Question Response Id
    Surrogate identifier for the question response.
  • Title: Question Text
    Read Only: true
    Maximum Length: 2000
    Text of the question that a participant responds to.
  • Title: Answer Score
    Read Only: true
    Calculated score for the responses provided for a question by a participant.
Nested Schema : Question Response Attachments
Type: array
Title: Question Response Attachments
The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
Show Source
Nested Schema : recruitingICEJobApplicationDrafts-questionnaireResponses-questionResponses-questionResponseAttachments-item-response
Type: object
Show Source
Nested Schema : Question Responses
Type: array
Title: Question Responses
The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.
Show Source
Nested Schema : recruitingICEJobApplicationDrafts-questionnaireResponses-questionResponses-questionResponseAttachments-QuestionResponses-item-response
Type: object
Show Source
  • Title: Answer Code
    Read Only: true
    Maximum Length: 240
    The answer code that a participant chose when responding to a single choice question.
  • Title: Answer Code List
    Concatenated list of answer choices, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.
  • Title: Comments
    Maximum Length: 4000
    Additional comments provided by the participant when responding to a question.
  • Title: Answer
    Attachment provided by the participant when responding to a question.
  • Title: Answer List
    Maximum Length: 2000
    Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.
  • Title: Answer Short Description
    Read Only: true
    Maximum Length: 240
    Text of the answer chosen by a participant when responding to a single choice question.
  • Title: Answer Short Description
    Read Only: true
    Concatenated list of answer texts, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.
  • Title: Choice List Code
    Concatenated list of answer codes, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.
  • Title: Choice List
    Maximum Length: 2000
    Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.
  • Title: Choice Short Description
    Read Only: true
    Concatenated list of answer texts, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    User who created the question response.
  • Title: Creation Date
    Read Only: true
    Date on which the question response was created.
  • Title: Last Update Date
    Read Only: true
    Date on which the question response was updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    User who last updated the question response.
  • Links
  • Title: Question Answer Id
    Surrogate identifier of the answer that a participant chose when responding to a single choice question.
  • Title: Question Code
    Maximum Length: 240
    Alphanumeric value that uniquely identifies a question defined for a subscriber.
  • Title: Question Id
    Surrogate identifier for the question.
  • Title: Questionnaire Question Id
    Surrogate identifier for the question in a questionnaire.
  • Question Response Attachments
    Title: Question Response Attachments
    The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
  • Title: Question Response Id
    Surrogate identifier for the question response.
  • Title: Question Text
    Read Only: true
    Maximum Length: 2000
    Text of the question that a participant responds to.
  • Title: Answer Score
    Read Only: true
    Calculated score for the responses provided for a question by a participant.
Nested Schema : Question Response Attachments
Type: array
Title: Question Response Attachments
The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
Show Source
Nested Schema : recruitingICEJobApplicationDrafts-questionnaireResponses-questionResponses-questionResponseAttachments-QuestionResponses-questionResponseAttachments-item-response
Type: object
Show Source
Back to Top