REST API for Oracle Fusion Cloud HCM

Get all questions

get

/hcmRestApi/resources/11.13.18.05/questionsLOV

Request

Query Parameters

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 the questions that match the specified primary key criteria.
  Finder Variables
  - QstnVersionNumber; integer; Version of the question.
  - QuestionId; integer; Application generated primary key of the question.
- findByWord Finds all the questions that match the specified criteria.
  Finder Variables
  - ExcludeQuestionId; string; A list of questions to exclude.
  - FilterAttributes; string; Attributes for the search parameters of questions.
  - ListOfCandidateCodes; string; List of candidate codes associated with a contextual question.
  - ListOfJobFamilyIds; string; List of job family identifiers associated to a contextual questions.
  - ListOfJobFunctionCodes; string; List of job function codes associated with a contextual question.
  - ListOfLocationIds; string; List of location identifiers associated with a contextual question.
  - ListOfOrganizationIds; string; List of organization identifiers associated with a contextual question.
  - ListOfQstnClassificationCodes; string; List of question classification codes associated to contextual questions.
  - QuestionnaireId; integer; Application generated primary key of the questionnaire, which includes the questions.
  - QuestionnaireVersionNumber; integer; Version number of the questionnaire.
  - SearchTerms; string; Search terms used to retrieve question data.
  - StartsWithFlag; boolean; Option to start with the specified criteria for searching the questions.
  - SubscriberCode; string; Unique code of the subscribing application where the question is used.
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:
- AdhocFlag; boolean; Indicates whether an additional question is added by a person who requested a response to the questionnaire. Value Y indicates that the question is an additional question displayed for the request. Value N indicates that the question is defined in the questionnaire and is displayed for all requests.
- AllJobFamiliesFlag; boolean; Indicates whether the contextual question is displayed for all the job families.
- AllJobFunctionsFlag; boolean; Indicates whether the contextual question is displayed for all the job functions.
- AllLocationsFlag; boolean; Indicates whether the contextual question is displayed for all the locations.
- AllOrganizationsFlag; boolean; Indicates whether the contextual question is displayed for all the organizations.
- AttachmentAllowed; string; Indicates whether an attachment is requested in the question. Valid values are Y and N.
- CandidateCode; string; Used to determine if the contextual question is displayed in the questionnaire.
- CategoryId; integer; Unique identifier of the folder where the question is stored.
- CategoryName; string; Name of the folder where the question is stored.
- ClassificationCode; string; Used to determine if the question is displayed in the questionnaire. For example, Disqualification or Preliminary.
- ClassificationMeaning; string; Meaning of the question classification code.
- ConditionalDisplayFlag; boolean; Indicates whether a question is conditionally displayed.
- ControllingQuestionCode; string; Question code for the controlling question, response to which determines if the question is displayed or not.
- ControllingQuestionId; integer; Surrogate identifier of the controlling question.
- ControllingQuestionVersionNumber; integer; Question version number of the controlling question.
- LatestVersion; string; Indicates whether the version of the questionnaire is the latest. The default value is Y. The latest version is used in new questionnaire responses.
- MaximumDate; string; Latest date to be support the response when a participant responds to a question.
- MaximumLength; string; Maximum number of characters the respondent can provide when answering a text type of question.
- MaximumPossibleScore; integer; Maximum score that the response can result in for the question.
- MaximumSelections; integer; Maximum number of choices that the respondent can select when answering a multiple choice type of question.
- MaximumThresholdScore; integer; Score of the question if the actual score is above the threshold. It's used to normalize question scores when the score methodology requires high response scores.
- MinimumDate; string; Earliest date to support the response when a participant responds to a question.
- MinimumLength; integer; Minimum number of characters that the respondent can provide when answering a text type of question.
- MinimumSelections; integer; Minimum number of choices that the respondent can select when answering a multiple choice type of question.
- MinimumThresholdScore; integer; Score of the question if the actual score is below the threshold. It's used to normalize question scores when the score methodology requires low response scores.
- Owner; string; Owner of the question. Indicates the person ID of the person who can edit the question, when private.
- PrivacyFlag; boolean; Indicates whether the question is private. Y indicates that the question is private and only the owner can edit. N indicates that the question is public and anyone can edit with the required privileges
- QstnVersionNumber; integer; Version of the question. When the definition of a question changes, then that change can be versioned.
- QuestionCode; string; User-defined identifier of the question.
- QuestionId; integer; Application generated primary key for the question.
- QuestionText; string; Text displayed as the question in the questionnaire.
- QuestionType; string; Type of question such as Single Choice, Multiple Choice, Text, or No Response.
- QuestionTypeCode; string; Code for the question type such as 1CHOICE, MULTCHOICE, TEXT, NONE.
- RatingModelId; integer; Identifier of the rating model. You can use it in single or multiple choice type of questions
- ResponseTypeId; integer; Identifier for the response type. It controls the display of the response such as rich text editor, list, radio buttons and check boxes.
- ScoredFlag; boolean; Indicates whether the question contributes to the calculation of the score in a scored questionnaire.
- Status; string; Status of the question such as Active, Draft, or Inactive.
- SubscriberCode; string; Unique code of the subscribing application where the question is used.
- SubscriberId; integer; Identifier of the subscribing application where the question is used.
- VersionDescription; string; Description of the version of the question.
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:

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.

There's no request body for this operation.

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.

Root Schema : questionsLOV

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/questionsLOV-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"LOV"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

Array of: object questionsLOV-item-response

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

Type: object

Show Source

AdhocFlag: boolean

Title: Additional Question

Read Only: true

Maximum Length: 30

Default Value: false

Indicates whether an additional question is added by a person who requested a response to the questionnaire. Value Y indicates that the question is an additional question displayed for the request. Value N indicates that the question is defined in the questionnaire and is displayed for all requests.
AllJobFamiliesFlag: boolean

Read Only: true

Maximum Length: 30

Indicates whether the contextual question is displayed for all the job families.
AllJobFunctionsFlag: boolean

Read Only: true

Maximum Length: 30

Indicates whether the contextual question is displayed for all the job functions.
AllLocationsFlag: boolean

Read Only: true

Maximum Length: 30

Indicates whether the contextual question is displayed for all the locations.
AllOrganizationsFlag: boolean

Read Only: true

Maximum Length: 30

Indicates whether the contextual question is displayed for all the organizations.
AttachmentAllowed: string

Title: Allow attachments

Read Only: true

Maximum Length: 30

Default Value: N

Indicates whether an attachment is requested in the question. Valid values are Y and N.
CandidateCode: string

Read Only: true

Maximum Length: 30

Used to determine if the contextual question is displayed in the questionnaire.
CategoryId: integer (int64)

Title: Folder

Read Only: true

Unique identifier of the folder where the question is stored.
CategoryName: string

Title: Folder

Read Only: true

Maximum Length: 240

Name of the folder where the question is stored.
ClassificationCode: string

Read Only: true

Maximum Length: 30

Used to determine if the question is displayed in the questionnaire. For example, Disqualification or Preliminary.
ClassificationMeaning: string

Title: Question Classification

Read Only: true

Maximum Length: 80

Meaning of the question classification code.
ConditionalDisplayFlag: boolean

Title: Conditional Display

Read Only: true

Maximum Length: 30

Indicates whether a question is conditionally displayed.
ControllingQuestionCode: string

Title: Controlling Question Code

Read Only: true

Maximum Length: 240

Question code for the controlling question, response to which determines if the question is displayed or not.
ControllingQuestionId: integer (int64)

Title: Controlling Question Id

Read Only: true

Surrogate identifier of the controlling question.
ControllingQuestionVersionNumber: integer (int64)

Read Only: true

Question version number of the controlling question.
LatestVersion: string

Title: Latest Version

Read Only: true

Maximum Length: 30

Default Value: N

Indicates whether the version of the questionnaire is the latest. The default value is Y. The latest version is used in new questionnaire responses.
links: array Links

Title: Links

The link relations associated with the resource instance.
MaximumDate: string (date)

Read Only: true

Latest date to be support the response when a participant responds to a question.
MaximumLength: string

Title: Maximum Characters

Read Only: true

Maximum Length: 20

Maximum number of characters the respondent can provide when answering a text type of question.
MaximumPossibleScore: integer (int64)

Title: Maximum Possible Score

Read Only: true

Maximum score that the response can result in for the question.
MaximumSelections: integer (int64)

Title: Maximum Number of Selections

Read Only: true

Maximum number of choices that the respondent can select when answering a multiple choice type of question.
MaximumThresholdScore: integer (int64)

Title: Maximum Calculated Score

Read Only: true

Score of the question if the actual score is above the threshold. It's used to normalize question scores when the score methodology requires high response scores.
MinimumDate: string (date)

Read Only: true

Earliest date to support the response when a participant responds to a question.
MinimumLength: integer (int64)

Title: Minimum Length

Read Only: true

Minimum number of characters that the respondent can provide when answering a text type of question.
MinimumSelections: integer (int64)

Title: Minimum Number of Selections

Read Only: true

Minimum number of choices that the respondent can select when answering a multiple choice type of question.
MinimumThresholdScore: integer (int64)

Title: Minimum Calculated Score

Read Only: true

Score of the question if the actual score is below the threshold. It's used to normalize question scores when the score methodology requires low response scores.
Owner: string

Title: Owner

Read Only: true

Maximum Length: 64

Owner of the question. Indicates the person ID of the person who can edit the question, when private.
PrivacyFlag: boolean

Title: Privacy

Read Only: true

Maximum Length: 30

Default Value: false

Indicates whether the question is private. Y indicates that the question is private and only the owner can edit. N indicates that the question is public and anyone can edit with the required privileges
QstnVersionNumber: integer (int64)

Title: Question Version Number

Read Only: true

Default Value: 1

Version of the question. When the definition of a question changes, then that change can be versioned.
QuestionCode: string

Title: Question Code

Read Only: true

Maximum Length: 240

User-defined identifier of the question.
QuestionId: integer (int64)

Title: Question Code

Read Only: true

Application generated primary key for the question.
QuestionText: string

Title: Question Text

Read Only: true

Maximum Length: 2000

Text displayed as the question in the questionnaire.
QuestionType: string

Title: Meaning

Read Only: true

Maximum Length: 80

Type of question such as Single Choice, Multiple Choice, Text, or No Response.
QuestionTypeCode: string

Title: Question Type

Read Only: true

Maximum Length: 30

Default Value: TEXT

Code for the question type such as 1CHOICE, MULTCHOICE, TEXT, NONE.
RatingModelId: integer (int64)

Title: Rating Model

Read Only: true

Identifier of the rating model. You can use it in single or multiple choice type of questions
ResponseTypeId: integer (int64)

Title: Response Type

Read Only: true

Default Value: 1

Identifier for the response type. It controls the display of the response such as rich text editor, list, radio buttons and check boxes.
ScoredFlag: boolean

Title: Score Question

Read Only: true

Maximum Length: 30

Indicates whether the question contributes to the calculation of the score in a scored questionnaire.
Status: string

Title: Status

Read Only: true

Maximum Length: 30

Default Value: D

Status of the question such as Active, Draft, or Inactive.
SubscriberCode: string

Title: Subscriber

Read Only: true

Maximum Length: 30

Unique code of the subscribing application where the question is used.
SubscriberId: integer (int64)

Title: Subscriber

Read Only: true

Identifier of the subscribing application where the question is used.
VersionDescription: string

Title: Version Description

Read Only: true

Maximum Length: 2000

Description of the version of the question.

{
    "type":"object",
    "properties":{
        "CategoryId":{
            "title":"Folder",
            "type":"integer",
            "description":"Unique identifier of the folder where the question is stored.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Owner":{
            "title":"Owner",
            "maxLength":64,
            "type":"string",
            "description":"Owner of the question. Indicates the person ID of the person who can edit the question, when private.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CandidateCode":{
            "maxLength":30,
            "type":"string",
            "description":"Used to determine if the contextual question is displayed in the questionnaire.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RatingModelId":{
            "title":"Rating Model",
            "type":"integer",
            "description":"Identifier of the rating model. You can use it in single or multiple choice type of questions",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MinimumLength":{
            "title":"Minimum Length",
            "type":"integer",
            "description":"Minimum number of characters that the respondent can provide when answering a text type of question.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MinimumDate":{
            "type":"string",
            "description":"Earliest date to support the response when a participant responds to a question.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrivacyFlag":{
            "title":"Privacy",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the question is private. Y indicates that the question is private and only the owner can edit. N indicates that the question is public and anyone can edit with the required privileges",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "MaximumPossibleScore":{
            "title":"Maximum Possible Score",
            "type":"integer",
            "description":"Maximum score that the response can result in for the question.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AllLocationsFlag":{
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the contextual question is displayed for all the locations.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QuestionCode":{
            "title":"Question Code",
            "maxLength":240,
            "type":"string",
            "description":"User-defined identifier of the question.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AttachmentAllowed":{
            "title":"Allow attachments",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether an attachment is requested in the question. Valid values are Y and N.",
            "nullable":true,
            "readOnly":true,
            "default":"N",
            "x-queryable":true
        },
        "MaximumLength":{
            "title":"Maximum Characters",
            "maxLength":20,
            "type":"string",
            "description":"Maximum number of characters the respondent can provide when answering a text type of question.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScoredFlag":{
            "title":"Score Question",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the question contributes to the calculation of the score in a scored questionnaire.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MaximumDate":{
            "type":"string",
            "description":"Latest date to be support the response when a participant responds to a question.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClassificationCode":{
            "maxLength":30,
            "type":"string",
            "description":"Used to determine if the question is displayed in the questionnaire. For example, Disqualification or Preliminary.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubscriberId":{
            "title":"Subscriber",
            "type":"integer",
            "description":"Identifier of the subscribing application where the question is used.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MinimumThresholdScore":{
            "title":"Minimum Calculated Score",
            "type":"integer",
            "description":"Score of the question if the actual score is below the threshold. It's used to normalize question scores when the score methodology requires low response scores.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MinimumSelections":{
            "title":"Minimum Number of Selections",
            "type":"integer",
            "description":"Minimum number of choices that the respondent can select when answering a multiple choice type of question.",
            "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"
            }
        },
        "QuestionText":{
            "title":"Question Text",
            "maxLength":2000,
            "type":"string",
            "description":"Text displayed as the question in the questionnaire.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ControllingQuestionCode":{
            "title":"Controlling Question Code",
            "maxLength":240,
            "type":"string",
            "description":"Question code for the controlling question, response to which determines if the question is displayed or not.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"Status of the question such as Active, Draft, or Inactive.",
            "nullable":false,
            "readOnly":true,
            "default":"D",
            "x-queryable":true
        },
        "AllJobFamiliesFlag":{
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the contextual question is displayed for all the job families.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ControllingQuestionId":{
            "title":"Controlling Question Id",
            "type":"integer",
            "description":"Surrogate identifier of the controlling question.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ControllingQuestionVersionNumber":{
            "type":"integer",
            "description":"Question version number of the controlling question.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "VersionDescription":{
            "title":"Version Description",
            "maxLength":2000,
            "type":"string",
            "description":"Description of the version of the question.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AllOrganizationsFlag":{
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the contextual question is displayed for all the organizations.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QstnVersionNumber":{
            "title":"Question Version Number",
            "type":"integer",
            "description":"Version of the question. When the definition of a question changes, then that change can be versioned.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "default":1,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "QuestionType":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Type of question such as Single Choice, Multiple Choice, Text, or No Response.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ConditionalDisplayFlag":{
            "title":"Conditional Display",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether a question is conditionally displayed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClassificationMeaning":{
            "title":"Question Classification",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of the question classification code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AllJobFunctionsFlag":{
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the contextual question is displayed for all the job functions.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubscriberCode":{
            "title":"Subscriber",
            "maxLength":30,
            "type":"string",
            "description":"Unique code of the subscribing application where the question is used.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LatestVersion":{
            "title":"Latest Version",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the version of the questionnaire is the latest. The default value is Y. The latest version is used in new questionnaire responses.",
            "nullable":true,
            "readOnly":true,
            "default":"N",
            "x-queryable":true
        },
        "QuestionId":{
            "title":"Question Code",
            "type":"integer",
            "description":"Application generated primary key for the question.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MaximumSelections":{
            "title":"Maximum Number of Selections",
            "type":"integer",
            "description":"Maximum number of choices that the respondent can select when answering a multiple choice type of question.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "QuestionTypeCode":{
            "title":"Question Type",
            "maxLength":30,
            "type":"string",
            "description":"Code for the question type such as 1CHOICE, MULTCHOICE, TEXT, NONE.",
            "nullable":false,
            "readOnly":true,
            "default":"TEXT",
            "x-queryable":true
        },
        "AdhocFlag":{
            "title":"Additional Question",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether an additional question is added by a person who requested a response to the questionnaire. Value Y indicates that the question is an additional question displayed for the request. Value N indicates that the question is defined in the questionnaire and is displayed for all requests.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Folder",
            "maxLength":240,
            "type":"string",
            "description":"Name of the folder where the question is stored.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MaximumThresholdScore":{
            "title":"Maximum Calculated Score",
            "type":"integer",
            "description":"Score of the question if the actual score is above the threshold. It's used to normalize question scores when the score methodology requires high response scores.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResponseTypeId":{
            "title":"Response Type",
            "type":"integer",
            "description":"Identifier for the response type. It controls the display of the response such as rich text editor, list, radio buttons and check boxes.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "default":1,
            "x-hints":{
                "precision":18
            },
            "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."
        }
    }
}