REST API for Oracle Fusion Cloud HCM

Get a questionnaire

get

/hcmRestApi/resources/11.13.18.05/questionnairesLOV/{questionnairesLOVUniqID}

Request

Path Parameters

questionnairesLOVUniqID(required): string

This is the hash key of the attributes which make up the composite key for the Questionnaires List of Values resource and used to uniquely identify an instance of Questionnaires List of Values. The client should not generate the hash key value. Instead, the client should query on the Questionnaires List of Values collection resource in order to navigate to a specific instance of Questionnaires 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

Effective-Of:

This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
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 : questionnairesLOV-item-response

Type: object

Show Source

CalculationRuleCode: string

Title: Overall Score Calculation Rule

Read Only: true

Maximum Length: 30

Code for the calculation rule for scored questionnaires.
CategoryId: integer (int64)

Title: Folder

Read Only: true

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

Title: Folder

Read Only: true

Maximum Length: 240

Name of the folder where the questionnaire is stored.
CreationDate: string (date-time)

Title: Creation Date

Read Only: true

Who column for creation date
Description: string

Title: Description

Read Only: true

Maximum Length: 2000

Description of the questionnaire.
IntroText: string

Title: Introduction

Read Only: true

Maximum Length: 4000

Introduction of the questionnaire displayed to a respondent.
InUse: string

Title: In Use

Read Only: true

Maximum Length: 30

Default Value: N

Indicates whether the questionnaire has at least one response.
InUseMeaning: string

Title: In Use

Read Only: true

Maximum Length: 80

Meaning of the In Use code.
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.
MaximumPossibleScore: integer (int64)

Title: Maximum Possible Score

Read Only: true

Maximum score that you can achieve in the questionnaire.
Name: string

Title: Questionnaire Name

Read Only: true

Maximum Length: 240

Name of the questionnaire.
Owner: string

Title: Owner

Read Only: true

Maximum Length: 240

Owner of the questionnaire. Indicates the person ID who can edit the questionnaire, when private.
PageLayout: string

Title: Page Layout

Read Only: true

Maximum Length: 30

Default Value: 1

Layout of the questionnaire on a page. This isn't applicable to mobile responsive pages.
PrivacyFlag: boolean

Title: Privacy

Read Only: true

Maximum Length: 30

Default Value: false

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

Title: Questionnaire Template ID

Read Only: true

Unique identifier of the template used to create the questionnaire.
QstnrVersionNumber: integer (int64)

Title: Questionnaire Version Number

Read Only: true

Default Value: 1

Version of the questionnaire. When the definition of a questionnaire changes, you can version the change and retain the original definition of the questionnaire.
QstnsPERPage: integer (int64)

Title: Maximum Number of Questions per Page

Read Only: true

Number of questions displayed on a page. This isn't applicable to mobile responsive pages.
QuestionnaireCode: string

Title: Questionnaire Code

Read Only: true

Maximum Length: 240

User-defined identifier of the questionnaire.
QuestionnaireId: integer (int64)

Title: Questionnaire ID

Read Only: true

Application generated primary key of the questionnaire.
ScoredFlag: boolean

Title: Score Questionnaire

Read Only: true

Maximum Length: 30

Indicates whether a score is calculated for the questionnaire.
SectionOrder: string

Title: Section Order

Read Only: true

Maximum Length: 30

Default Value: S

Section order when responding to the questionnaire. Valid options are Sequential and Random.
SectionPresentation: string

Title: Section Presentation

Read Only: true

Maximum Length: 30

Default Value: S

Presentation of sections when responding to the questionnaire. Valid options are Stack Regions and No Sections.
Status: string

Title: Status

Read Only: true

Maximum Length: 30

Default Value: D

Status of the questionnaire. Valid values are Active, Draft, and Inactive.
SubscriberCode: string

Title: Subscriber

Read Only: true

Maximum Length: 30

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

Title: Subscriber

Read Only: true

Identifier of the subscribing application where the questionnaire is used.
TemplateFlag: boolean

Title: Template

Read Only: true

Maximum Length: 30

Default Value: false

Indicates whether the questionnaire is a template.
VersionDescription: string

Title: Version Description

Read Only: true

Maximum Length: 2000

Description of the version of the questionnaire.

{
    "type":"object",
    "properties":{
        "CategoryId":{
            "title":"Folder",
            "type":"integer",
            "description":"Unique identifier of the folder where the questionnaire is stored.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Who column for creation date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "QstnrVersionNumber":{
            "title":"Questionnaire Version Number",
            "type":"integer",
            "description":"Version of the questionnaire. When the definition of a questionnaire changes, you can version the change and retain the original definition of the questionnaire.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "default":1,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Owner":{
            "title":"Owner",
            "maxLength":240,
            "type":"string",
            "description":"Owner of the questionnaire. Indicates the person ID who can edit the questionnaire, when private.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":2000,
            "type":"string",
            "description":"Description of the questionnaire.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrivacyFlag":{
            "title":"Privacy",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the questionnaire is private. Y indicates that the questionnaire is private and only the owner can edit. N indicates that the questionnaire is public and anyone can edit it with the required privileges.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"false"
            },
            "x-queryable":true
        },
        "MaximumPossibleScore":{
            "title":"Maximum Possible Score",
            "type":"integer",
            "description":"Maximum score that you can achieve in the questionnaire.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Questionnaire Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the questionnaire.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ScoredFlag":{
            "title":"Score Questionnaire",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether a score is calculated for the questionnaire.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubscriberId":{
            "title":"Subscriber",
            "type":"integer",
            "description":"Identifier of the subscribing application where the questionnaire is used.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "QuestionnaireId":{
            "title":"Questionnaire ID",
            "type":"integer",
            "description":"Application generated primary key 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"
            }
        },
        "InUseMeaning":{
            "title":"In Use",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of the In Use code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CalculationRuleCode":{
            "title":"Overall Score Calculation Rule",
            "maxLength":30,
            "type":"string",
            "description":"Code for the calculation rule for scored questionnaires.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SectionPresentation":{
            "title":"Section Presentation",
            "maxLength":30,
            "type":"string",
            "description":"Presentation of sections when responding to the questionnaire. Valid options are Stack Regions and No Sections.",
            "nullable":true,
            "readOnly":true,
            "default":"S",
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"false"
            },
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"Status of the questionnaire. Valid values are Active, Draft, and Inactive.",
            "nullable":false,
            "readOnly":true,
            "default":"D",
            "x-queryable":true
        },
        "VersionDescription":{
            "title":"Version Description",
            "maxLength":2000,
            "type":"string",
            "description":"Description of the version of the questionnaire.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SectionOrder":{
            "title":"Section Order",
            "maxLength":30,
            "type":"string",
            "description":"Section order when responding to the questionnaire. Valid options are Sequential and Random.",
            "nullable":true,
            "readOnly":true,
            "default":"S",
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"false"
            },
            "x-queryable":true
        },
        "QstnrTemplateId":{
            "title":"Questionnaire Template ID",
            "type":"integer",
            "description":"Unique identifier of the template used to create the questionnaire.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SubscriberCode":{
            "title":"Subscriber",
            "maxLength":30,
            "type":"string",
            "description":"Unique code of the subscribing application where the questionnaire 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
        },
        "PageLayout":{
            "title":"Page Layout",
            "maxLength":30,
            "type":"string",
            "description":"Layout of the questionnaire on a page. This isn't applicable to mobile responsive pages.",
            "nullable":true,
            "readOnly":true,
            "default":"1",
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"false"
            },
            "x-queryable":true
        },
        "QstnsPERPage":{
            "title":"Maximum Number of Questions per Page",
            "type":"integer",
            "description":"Number of questions displayed on a page. This isn't applicable to mobile responsive pages.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Folder",
            "maxLength":240,
            "type":"string",
            "description":"Name of the folder where the questionnaire is stored.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InUse":{
            "title":"In Use",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the questionnaire has at least one response.",
            "nullable":true,
            "readOnly":true,
            "default":"N",
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "IntroText":{
            "title":"Introduction",
            "maxLength":4000,
            "type":"string",
            "description":"Introduction of the questionnaire displayed to a respondent.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TemplateFlag":{
            "title":"Template",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the questionnaire is a template.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"false"
            },
            "x-queryable":true
        },
        "QuestionnaireCode":{
            "title":"Questionnaire Code",
            "maxLength":240,
            "type":"string",
            "description":"User-defined identifier of the questionnaire.",
            "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."
        }
    }
}