Jump to

• Request
• Response
• Examples

Get a question

get

/hcmRestApi/resources/11.13.18.05/questionnaireQuestionsLOV/{questionnaireQuestionsLOVUniqID}

Request

Path Parameters

• questionnaireQuestionsLOVUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Questionnaire Questions List of Values resource and used to uniquely identify an instance of Questionnaire Questions List of Values. The client should not generate the hash key value. Instead, the client should query on the Questionnaire Questions List of Values collection resource in order to navigate to a specific instance of Questionnaire Questions List of Values to get the hash key.

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:
  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.

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

Type: object

Show Source

• AdhocQuestion: string
  Title: Additional Question

  Read Only: true

  Maximum Length: 30

  Default Value: N

  Indicates whether the question is an additional question added by a person requesting a response to the questionnaire. If the value is Y, the question is displayed only to specific participants as part of specific requests. If the value is N, the question is displayed to all participants for all requests.
• AttachmentAllowed: string
  Title: Allow attachments

  Read Only: true

  Maximum Length: 30

  Default Value: N

  Indicates whether the question is supported by attachments from the respondent. Valid values are Y and N.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who added the question to the questionnaire definition.
• CreationDate: string (date-time)
  Read Only: true

  Date and time of addition of the question to the questionnaire definition.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time of update of the question in the questionnaire definition.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the question in the questionnaire definition.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Mandatory: string
  Title: Required

  Read Only: true

  Maximum Length: 30

  Default Value: N

  Indicates whether the respondent needs to answer a question in a questionnaire. Valid values are Y and N.
• MaximumLength: string
  Title: Maximum Characters

  Read Only: true

  Maximum Length: 20

  Minimum number of characters that the respondent must provide when answering a text type of question.
• MaximumSelections: integer (int64)
  Title: Maximum Number of Selections

  Read Only: true

  Minimum number of choices that the respondent must select when answering a multiple choice type of question.
• MinimumLength: integer (int64)
  Title: Minimum Length

  Read Only: true

  Maximum 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

  Maximum number of choices that the respondent can select when answering a multiple choice type of question.
• QuestionCode: string
  Title: Question Code

  Read Only: true

  Maximum Length: 240

  User-defined identifier of the question definition.
• QuestionId: integer (int64)
  Title: Question ID

  Read Only: true

  System-generated primary key for the question definition.
• QuestionnaireCode: string
  Title: Questionnaire Code

  Read Only: true

  Maximum Length: 240

  Alphanumeric code that uniquely identifies a questionnaire defined for a subscriber.
• QuestionnaireId: integer (int64)
  Title: Questionnaire ID

  Read Only: true

  Surrogate identifier of the questionnaire.
• QuestionnaireQuestionId: integer (int64)
  Title: Questionnaire Question ID

  Read Only: true

  System-generated primary key for the question in a questionnaire definition.
• QuestionSequenceNumber: integer (int64)
  Title: Sequence Number

  Read Only: true

  Sequence number of a question in the questionnaire and section definitions.
• 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 the question such as Single Choice, Multiple Choice, Text, or No Response.
• QuestionVersionNumber: integer (int64)
  Title: Question Version Number

  Read Only: true

  Version number of the question.
• SectionSequenceNumber: integer (int64)
  Title: Section Sequence Number

  Read Only: true

  Sequence number of the sections in a questionnaire definition.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the question in the questionnaire definition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time of addition of the question to the questionnaire definition.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AdhocQuestion":{
            "title":"Additional Question",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the question is an additional question added by a person requesting a response to the questionnaire. If the value is Y, the question is displayed only to specific participants as part of specific requests. If the value is N, the question is displayed to all participants for all requests.",
            "nullable":false,
            "readOnly":true,
            "default":"N",
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who added the question to the questionnaire definition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MinimumLength":{
            "title":"Minimum Length",
            "type":"integer",
            "description":"Maximum 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
        },
        "QuestionType":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Type of the question such as Single Choice, Multiple Choice, Text, or No Response.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "QuestionSequenceNumber":{
            "title":"Sequence Number",
            "type":"integer",
            "description":"Sequence number of a question in the questionnaire and section definitions.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "QuestionnaireQuestionId":{
            "title":"Questionnaire Question ID",
            "type":"integer",
            "description":"System-generated primary key for the question in a questionnaire definition.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "QuestionCode":{
            "title":"Question Code",
            "maxLength":240,
            "type":"string",
            "description":"User-defined identifier of the question definition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "QuestionVersionNumber":{
            "title":"Question Version Number",
            "type":"integer",
            "description":"Version number of the question.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AttachmentAllowed":{
            "title":"Allow attachments",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the question is supported by attachments from the respondent. Valid values are Y and N.",
            "nullable":true,
            "readOnly":true,
            "default":"N",
            "x-queryable":true
        },
        "MaximumLength":{
            "title":"Maximum Characters",
            "maxLength":20,
            "type":"string",
            "description":"Minimum number of characters that the respondent must provide when answering a text type of question.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QuestionId":{
            "title":"Question ID",
            "type":"integer",
            "description":"System-generated primary key for the question definition.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MaximumSelections":{
            "title":"Maximum Number of Selections",
            "type":"integer",
            "description":"Minimum number of choices that the respondent must select when answering a multiple choice type of question.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MinimumSelections":{
            "title":"Minimum 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
        },
        "QuestionnaireId":{
            "title":"Questionnaire ID",
            "type":"integer",
            "description":"Surrogate identifier of the questionnaire.",
            "format":"int64",
            "nullable":false,
            "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
        },
        "SectionSequenceNumber":{
            "title":"Section Sequence Number",
            "type":"integer",
            "description":"Sequence number of the sections in a questionnaire definition.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "QuestionnaireCode":{
            "title":"Questionnaire Code",
            "maxLength":240,
            "type":"string",
            "description":"Alphanumeric code that uniquely identifies a questionnaire defined for a subscriber.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Mandatory":{
            "title":"Required",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the respondent needs to answer a question in a questionnaire. Valid values are Y and N.",
            "nullable":true,
            "readOnly":true,
            "default":"N",
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time of update of the question in the questionnaire definition.",
            "format":"date-time",
            "nullable":false,
            "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

Examples

The following example shows how to get a question associated with a questionnaire by submitting a singular GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -X GET https://<host>:<port>/hcmRestApi/resources/11.13.18.05/questionnaireQuestionsLOV/<questionnaireQuestionIdHash>

Example of Payload

The following is an example of the payload.

Example of Response Header

The following is an example of the response header.

HTTP/1.1 200 OK
Content-Type : application/vnd.oracle.adf.resourcecollection+json

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
    "QuestionnaireQuestionId": 10,
    "QuestionnaireCode": "400",
    "QuestionCode": "5000",
    "QuestionText": "What is your gender?",
    "QuestionId": 5000,
    "QuestionVersionNumber": 1,
    "QuestionType": "Single Choice",
    "AdhocQuestion": "N",
    "AttachmentAllowed": "N",
    "Mandatory": "Y",
    "MaximumLength": null,
    "MinimumLength": null,
    "MaximumSelections": null,
    "MinimumSelections": null,
    "CreatedBy": "SEED_DATA_FROM_APPLICATION",
    "CreationDate": "2017-02-06T00:43:13.922+00:00",
    "LastUpdateDate": "2017-02-06T00:43:14.333+00:00",
    "LastUpdatedBy": "SEED_DATA_FROM_APPLICATION",
    "links": [{...}]
}

Back to Top