Jump to

• Request
• Response

Create a prescreening question

post

/hcmRestApi/resources/11.13.18.05/recruitingUIQstnrQuestions

Request

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ClassificationCode: string
  Maximum Length: 255

  Classification code for the prescreening question.
• ClassificationDisplay: string
  Maximum Length: 255

  Classification display for the prescreening question.
• ConditionDisplay: string
  Maximum Length: 255

  Condition display for the prescreening question.
• ConditionQstnVersionNumber: integer
  Version number of the condition question for the prescreening question.
• ConditionQuestionCode: string
  Maximum Length: 255

  Code of the condition question for the prescreening question.
• ConditionQuestionId: integer
  ID of the condition question for the prescreening question.
• IsQuestionnaireEmptyFlag: boolean
  Maximum Length: 255

  Meaning of the type of questionnaire in use.
• Mandatory: string
  Maximum Length: 255

  Mandatory prescreening question.
• ObjectId: integer
  Requisition ID for the prescreening question.
• ObjectType: string
  Maximum Length: 255

  Requisition ID for the prescreening question.
• QstnrQuestionId: integer
  Questionnaire question ID.
• QstnrVersionNumber: integer
  Version number of the questionnaire for the prescreening question.
• QuestionCode: string
  Maximum Length: 255

  Question code for the prescreening question.
• QuestionId: integer
  Question ID for the prescreening question.
• QuestionnaireId: integer
  Questionnaire ID for the prescreening question.
• QuestionText: string
  Maximum Length: 255

  Question text for the prescreening question.
• QuestionType: string
  Maximum Length: 255

  Question type for the prescreening question.
• QuestionTypeDisplay: string
  Maximum Length: 255

  Display of the question type for the prescreening question.
• ResponseRequired: string
  Maximum Length: 255

  Response required for the prescreening question.
• Score: integer
  Score for the prescreening question.
• SequenceNumber: integer
  Sequence number of the prescreening question.

{
    "type":"object",
    "properties":{
        "QstnrVersionNumber":{
            "type":"integer",
            "description":"Version number of the questionnaire for the prescreening question.",
            "nullable":true
        },
        "ObjectId":{
            "type":"integer",
            "description":"Requisition ID for the prescreening question.",
            "nullable":true
        },
        "QuestionType":{
            "maxLength":255,
            "type":"string",
            "description":"Question type for the prescreening question.",
            "nullable":true
        },
        "IsQuestionnaireEmptyFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Meaning of the type of questionnaire in use.",
            "nullable":true
        },
        "ConditionQuestionCode":{
            "maxLength":255,
            "type":"string",
            "description":"Code of the condition question for the prescreening question.",
            "nullable":true
        },
        "QuestionTypeDisplay":{
            "maxLength":255,
            "type":"string",
            "description":"Display of the question type for the prescreening question.",
            "nullable":true
        },
        "ConditionQstnVersionNumber":{
            "type":"integer",
            "description":"Version number of the condition question for the prescreening question.",
            "nullable":true
        },
        "ClassificationDisplay":{
            "maxLength":255,
            "type":"string",
            "description":"Classification display for the prescreening question.",
            "nullable":true
        },
        "ConditionQuestionId":{
            "type":"integer",
            "description":"ID of the condition question for the prescreening question.",
            "nullable":true
        },
        "ObjectType":{
            "maxLength":255,
            "type":"string",
            "description":"Requisition ID for the prescreening question.",
            "nullable":true
        },
        "QuestionCode":{
            "maxLength":255,
            "type":"string",
            "description":"Question code for the prescreening question.",
            "nullable":true
        },
        "Score":{
            "type":"integer",
            "description":"Score for the prescreening question.",
            "nullable":true
        },
        "ResponseRequired":{
            "maxLength":255,
            "type":"string",
            "description":"Response required for the prescreening question.",
            "nullable":true
        },
        "ConditionDisplay":{
            "maxLength":255,
            "type":"string",
            "description":"Condition display for the prescreening question.",
            "nullable":true
        },
        "QuestionId":{
            "type":"integer",
            "description":"Question ID for the prescreening question.",
            "nullable":true
        },
        "ClassificationCode":{
            "maxLength":255,
            "type":"string",
            "description":"Classification code for the prescreening question.",
            "nullable":true
        },
        "QuestionnaireId":{
            "type":"integer",
            "description":"Questionnaire ID for the prescreening question.",
            "nullable":true
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"Sequence number of the prescreening question.",
            "nullable":true
        },
        "QstnrQuestionId":{
            "type":"integer",
            "description":"Questionnaire question ID.",
            "nullable":true
        },
        "QuestionText":{
            "maxLength":255,
            "type":"string",
            "description":"Question text for the prescreening question.",
            "nullable":true
        },
        "Mandatory":{
            "maxLength":255,
            "type":"string",
            "description":"Mandatory prescreening question.",
            "nullable":true
        }
    }
}

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 : recruitingUIQstnrQuestions-item-response

Type: object

Show Source

• ClassificationCode: string
  Maximum Length: 255

  Classification code for the prescreening question.
• ClassificationDisplay: string
  Maximum Length: 255

  Classification display for the prescreening question.
• ConditionDisplay: string
  Maximum Length: 255

  Condition display for the prescreening question.
• ConditionQstnVersionNumber: integer
  Version number of the condition question for the prescreening question.
• ConditionQuestionCode: string
  Maximum Length: 255

  Code of the condition question for the prescreening question.
• ConditionQuestionId: integer
  ID of the condition question for the prescreening question.
• IsQuestionnaireEmptyFlag: boolean
  Maximum Length: 255

  Meaning of the type of questionnaire in use.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Mandatory: string
  Maximum Length: 255

  Mandatory prescreening question.
• ObjectId: integer
  Requisition ID for the prescreening question.
• ObjectType: string
  Maximum Length: 255

  Requisition ID for the prescreening question.
• QstnrQuestionId: integer
  Questionnaire question ID.
• QstnrVersionNumber: integer
  Version number of the questionnaire for the prescreening question.
• QuestionCode: string
  Maximum Length: 255

  Question code for the prescreening question.
• QuestionId: integer
  Question ID for the prescreening question.
• QuestionnaireId: integer
  Questionnaire ID for the prescreening question.
• QuestionText: string
  Maximum Length: 255

  Question text for the prescreening question.
• QuestionType: string
  Maximum Length: 255

  Question type for the prescreening question.
• QuestionTypeDisplay: string
  Maximum Length: 255

  Display of the question type for the prescreening question.
• ResponseRequired: string
  Maximum Length: 255

  Response required for the prescreening question.
• Score: integer
  Score for the prescreening question.
• SequenceNumber: integer
  Sequence number of the prescreening question.

{
    "type":"object",
    "properties":{
        "QstnrVersionNumber":{
            "type":"integer",
            "description":"Version number of the questionnaire for the prescreening question.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectId":{
            "type":"integer",
            "description":"Requisition ID for the prescreening question.",
            "nullable":true,
            "x-queryable":true
        },
        "QuestionType":{
            "maxLength":255,
            "type":"string",
            "description":"Question type for the prescreening question.",
            "nullable":true,
            "x-queryable":true
        },
        "IsQuestionnaireEmptyFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Meaning of the type of questionnaire in use.",
            "nullable":true,
            "x-queryable":true
        },
        "ConditionQuestionCode":{
            "maxLength":255,
            "type":"string",
            "description":"Code of the condition question for the prescreening question.",
            "nullable":true,
            "x-queryable":true
        },
        "QuestionTypeDisplay":{
            "maxLength":255,
            "type":"string",
            "description":"Display of the question type for the prescreening question.",
            "nullable":true,
            "x-queryable":true
        },
        "ConditionQstnVersionNumber":{
            "type":"integer",
            "description":"Version number of the condition question for the prescreening question.",
            "nullable":true,
            "x-queryable":true
        },
        "ClassificationDisplay":{
            "maxLength":255,
            "type":"string",
            "description":"Classification display for the prescreening question.",
            "nullable":true,
            "x-queryable":true
        },
        "ConditionQuestionId":{
            "type":"integer",
            "description":"ID of the condition question for the prescreening question.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectType":{
            "maxLength":255,
            "type":"string",
            "description":"Requisition ID for the prescreening question.",
            "nullable":true,
            "x-queryable":true
        },
        "QuestionCode":{
            "maxLength":255,
            "type":"string",
            "description":"Question code for the prescreening question.",
            "nullable":true,
            "x-queryable":true
        },
        "Score":{
            "type":"integer",
            "description":"Score for the prescreening question.",
            "nullable":true,
            "x-queryable":true
        },
        "ResponseRequired":{
            "maxLength":255,
            "type":"string",
            "description":"Response required for the prescreening question.",
            "nullable":true,
            "x-queryable":true
        },
        "ConditionDisplay":{
            "maxLength":255,
            "type":"string",
            "description":"Condition display for the prescreening question.",
            "nullable":true,
            "x-queryable":true
        },
        "QuestionId":{
            "type":"integer",
            "description":"Question ID for the prescreening question.",
            "nullable":true,
            "x-queryable":true
        },
        "ClassificationCode":{
            "maxLength":255,
            "type":"string",
            "description":"Classification code for the prescreening question.",
            "nullable":true,
            "x-queryable":true
        },
        "QuestionnaireId":{
            "type":"integer",
            "description":"Questionnaire ID for the prescreening question.",
            "nullable":true,
            "x-queryable":true
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"Sequence number of the prescreening question.",
            "nullable":true,
            "x-queryable":true
        },
        "QstnrQuestionId":{
            "type":"integer",
            "description":"Questionnaire question ID.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "QuestionText":{
            "maxLength":255,
            "type":"string",
            "description":"Question text for the prescreening question.",
            "nullable":true,
            "x-queryable":true
        },
        "Mandatory":{
            "maxLength":255,
            "type":"string",
            "description":"Mandatory prescreening question.",
            "nullable":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