1. REST API for Oracle Fusion Cloud HCM
  2. Tasks
  3. Questionnaires

Update a questionnaire

patch

/hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key for the Questionnaires resource and used to uniquely identify an instance of Questionnaires. The client should not generate the hash key value. Instead, the client should query on the Questionnaires collection resource in order to navigate to a specific instance of Questionnaires to get the hash key.
Header Parameters
  • 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.
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Attachments
    Title: Attachments
    The attachments resource is a child of the questionnaires resource. It provides details of the attachments in a questionnaire.
  • Title: Score Calculation Rule Code
    Maximum Length: 30
    Calculation rule code for questionnaires that are scored.
  • Title: Description
    Maximum Length: 2000
    Description of the questionnaire.
  • Title: Owner
    Maximum Length: 64
    Name of the person with privileges to edit the questionnaire marked as private.
  • Title: Person Number
    Maximum Length: 30
    Person number of the person with privileges to edit the questionnaire marked as private.
  • Title: Instruction Text
    Maximum Length: 4000
    Instructions or additional information for the questionnaire.
  • Title: Display Format
    Maximum Length: 30
    Presentation format for questions in a questionnaire. This configuration is only available for Touchpoints subscribers.
  • Title: Privacy Code
    Maximum Length: 30
    Default Value: false
    Indicates whether the questionnaire is private. If a questionnaire is marked private, only the person specified by the editor attribute can edit the questionnaire. The default value is false.
  • Title: Questionnaire Name
    Maximum Length: 240
    Name of the questionnaire.
  • Title: Section Order Code
    Maximum Length: 30
    Default Value: S
    Code that shows the ordering sequence of the questionnaire sections. A value of R (Random) will randomize the sections and a value of S (Sequential) will present the sections in the defined sequence.
  • Title: Section Presentation Code
    Maximum Length: 30
    Default Value: S
    Code that shows if the sections display as stacked regions if the value is S or if the questions are presented without any sections when the value is N.
  • Sections
    Title: Sections
    The sections resource is a child resource of the questionnaires resource. It provides details of the sections defined in the questionnaire.
  • Title: Status Code
    Maximum Length: 30
    Default Value: D
    Status of the questionnaire. Valid values include A (Active), I (Inactive) and D (Draft).
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is a child of the questionnaires resource. It provides details of the attachments in a questionnaire.
Show Source
Nested Schema : Sections
Type: array
Title: Sections
The sections resource is a child resource of the questionnaires resource. It provides details of the sections defined in the questionnaire.
Show Source
Nested Schema : questionnaires-attachments-item-patch-request
Type: object
Show Source
Nested Schema : questionnaires-sections-item-patch-request
Type: object
Show Source
  • Title: Description
    Maximum Length: 2000
    Description of the questionnaire section.
  • Title: Introduction
    Maximum Length: 2000
    Introduction text for the questionnaire section.
  • Title: Required
    Maximum Length: 30
    Default Value: N
    Indicates whether the questionnaire section is mandatory. Valid values are Y and N. The default value is N.
  • Title: Question Order Code
    Maximum Length: 30
    Default Value: V
    Setting that shows the ordering sequence for the questions in a questionnaire section. Valid values include V (Vertical) for presenting the questions in defined sequence and R (Random) for presenting questions in random order.
  • Questions
    Title: Questions
    The questions resource is a child of the questionnaires resource. It provides details of the questions included in a section of the questionnaire.
  • Title: Sample Size
    Defines the number of questions presented to the participant of a questionnaire, when the question order is set to random.
  • Title: Response Order Code
    Maximum Length: 30
    Default Value: V
    Code that shows the ordering sequence for the answer choices in questions included in a questionnaire section. Valid values include V (Vertical) for presenting the answer choices in a question in the defined sequence and R (Random) for presenting answer choices in random order.
  • Title: Section Name
    Maximum Length: 240
    Name of the questionnaire section.
  • Title: Section Sequence Number
    Sequence number for a section in a questionnaire.
Nested Schema : Questions
Type: array
Title: Questions
The questions resource is a child of the questionnaires resource. It provides details of the questions included in a section of the questionnaire.
Show Source
Nested Schema : questionnaires-sections-questions-item-patch-request
Type: object
Show Source
  • Answers
    Title: Answers
    The answers resource is a child of the questionnaires resource. It provides details of the answer choices defined for a question that's included in a questionnaire section.
  • Title: Mandatory
    Maximum Length: 30
    Default Value: false
    Indicates whether the response to this question is mandatory. Participants can't skip this question without an answer. The default value is false.
  • Title: Maximum Calculated Score
    Maximum score limit for the question when the total score is calculated for a response to the question.
  • Title: Minimum Calculated Score
    Minimum score limit for the question when the total score is calculated for a response to the question.
  • Attachments
    Title: Attachments
    The attachments resource is used to view, create, and update attachments.
  • Title: Response Type Code
    Maximum Length: 30
    Response type for the question when presented to the participant. Valid values are defined in the questionnaireResponseTypesLOV.
  • Title: Sequence Number
    Sequence number of the question in a questionnaire template section.
Nested Schema : Answers
Type: array
Title: Answers
The answers resource is a child of the questionnaires resource. It provides details of the answer choices defined for a question that's included in a questionnaire section.
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : questionnaires-sections-questions-answers-item-patch-request
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : questionnaires-sections-questions-answers-answerAttachments-item-patch-request
Type: object
Show Source
Nested Schema : questionnaires-sections-questions-questionAttachments-item-patch-request
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : questionnaires-item-response
Type: object
Show Source
  • Attachments
    Title: Attachments
    The attachments resource is a child of the questionnaires resource. It provides details of the attachments in a questionnaire.
  • Title: Score Calculation Rule Code
    Maximum Length: 30
    Calculation rule code for questionnaires that are scored.
  • Title: Score Calculation Rule
    Read Only: true
    Maximum Length: 80
    Name of the score calculation rule for questionnaires that are scored.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    Name of the user who created the questionnaire.
  • Title: Creation Date
    Read Only: true
    Date when the questionnaire was created.
  • Title: Description
    Maximum Length: 2000
    Description of the questionnaire.
  • Title: Owner
    Maximum Length: 64
    Name of the person with privileges to edit the questionnaire marked as private.
  • Title: Person Number
    Maximum Length: 30
    Person number of the person with privileges to edit the questionnaire marked as private.
  • Title: Folder Id
    Surrogate identifier of the category or folder where the questionnaire is stored.
  • Title: Folder Name
    Maximum Length: 240
    Name of the category or folder where the questionnaire is stored.
  • Title: Instruction Text
    Maximum Length: 4000
    Instructions or additional information for the questionnaire.
  • Title: In Use Code
    Read Only: true
    Maximum Length: 30
    Default Value: N
    Code that shows whether the participants have already responded to the questionnaire.
  • Title: In Use
    Read Only: true
    Maximum Length: 80
    Meaning of the In Use code.
  • Title: Last Updated Date
    Read Only: true
    Date when the questionnaire was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    Name of the user who last updated the questionnaire.
  • Title: Latest Version
    Read Only: true
    Maximum Length: 30
    Default Value: false
    Setting that indicates if this is the latest version of the questionnaire. This is a read-only attribute.
  • Title: Display Format
    Maximum Length: 30
    Presentation format for questions in a questionnaire. This configuration is only available for Touchpoints subscribers.
  • Title: Display Format
    Read Only: true
    Maximum Length: 80
    Meaning of the display format code for the questionnaire.
  • Links
  • Title: Maximum Possible Score
    Read Only: true
    Sum of the maximum possible scores of all questions that are included in the questionnaire.
  • Title: Privacy Code
    Maximum Length: 30
    Default Value: false
    Indicates whether the questionnaire is private. If a questionnaire is marked private, only the person specified by the editor attribute can edit the questionnaire. The default value is false.
  • Title: Privacy
    Read Only: true
    Maximum Length: 80
    Meaning of the privacy code indicating if the questionnaire is marked private.
  • Title: Questionnaire Code
    Maximum Length: 240
    Alphanumeric code that uniquely identifies a questionnaire defined for a subscriber.
  • Title: Questionnaire Id
    Surrogate identifier of the questionnaire.
  • Title: Questionnaire Name
    Maximum Length: 240
    Name of the questionnaire.
  • Title: Questionnaire Code
    Maximum Length: 240
    Alphanumeric value that uniquely identifies the questionnaire template referred to by the questionnaire.
  • Title: Questionnaire Template ID
    Surrogate identifier of the questionnaire template.
  • Title: Questionnaire Template Name
    Read Only: true
    Maximum Length: 240
    Name of the questionnaire template.
  • Title: Score Questionnaire
    Read Only: true
    Maximum Length: 30
    Setting that indicates if the questionnaire is scored. This is a read-only attribute.
  • Title: Section Order Code
    Maximum Length: 30
    Default Value: S
    Code that shows the ordering sequence of the questionnaire sections. A value of R (Random) will randomize the sections and a value of S (Sequential) will present the sections in the defined sequence.
  • Title: Section Order
    Read Only: true
    Maximum Length: 80
    Meaning of the section order code.
  • Title: Section Presentation Code
    Maximum Length: 30
    Default Value: S
    Code that shows if the sections display as stacked regions if the value is S or if the questions are presented without any sections when the value is N.
  • Title: Section Presentation
    Read Only: true
    Maximum Length: 80
    Meaning of the section presentation code.
  • Sections
    Title: Sections
    The sections resource is a child resource of the questionnaires resource. It provides details of the sections defined in the questionnaire.
  • Title: Status Code
    Maximum Length: 30
    Default Value: D
    Status of the questionnaire. Valid values include A (Active), I (Inactive) and D (Draft).
  • Title: Status
    Read Only: true
    Maximum Length: 80
    Meaning of the status code.
  • Title: Subscriber Code
    Maximum Length: 30
    Code for the subscriber using the questionnaire. Valid values are defined in the list questionnaireSubscribersLOV.
  • Title: Subscriber Id
    Surrogate identifier for the subscriber.
  • Title: Subscriber Name
    Read Only: true
    Maximum Length: 240
    Name of the subscriber using the questionnaire template.
  • Title: Version Description
    Maximum Length: 2000
    Description provided when a new version of a questionnaire is created.
  • Title: Version Number
    Default Value: 1
    Version number of the questionnaire. Version Number should be 1 when a new questionnaire is created.
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is a child of the questionnaires resource. It provides details of the attachments in a questionnaire.
Show Source
Nested Schema : Sections
Type: array
Title: Sections
The sections resource is a child resource of the questionnaires resource. It provides details of the sections defined in the questionnaire.
Show Source
Nested Schema : questionnaires-attachments-item-response
Type: object
Show Source
Nested Schema : questionnaires-sections-item-response
Type: object
Show Source
  • Title: Allow Additional Questions
    Read Only: true
    Maximum Length: 30
    Default Value: false
    Indicates whether you can include informal or casual questions in a questionnaire section when a response is requested for a questionnaire. The default value is false.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    Name of the user who created the section.
  • Title: Creation Date
    Read Only: true
    Date when the section was created.
  • Title: Description
    Maximum Length: 2000
    Description of the questionnaire section.
  • Title: Introduction
    Maximum Length: 2000
    Introduction text for the questionnaire section.
  • Title: Last Update Date
    Read Only: true
    Date when the section was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    Name of the user who last updated the section.
  • Links
  • Title: Required
    Maximum Length: 30
    Default Value: N
    Indicates whether the questionnaire section is mandatory. Valid values are Y and N. The default value is N.
  • Title: Question Order Code
    Maximum Length: 30
    Default Value: V
    Setting that shows the ordering sequence for the questions in a questionnaire section. Valid values include V (Vertical) for presenting the questions in defined sequence and R (Random) for presenting questions in random order.
  • Title: Question Order
    Read Only: true
    Maximum Length: 80
    Meaning of the question order code.
  • Questions
    Title: Questions
    The questions resource is a child of the questionnaires resource. It provides details of the questions included in a section of the questionnaire.
  • Title: Sample Size
    Defines the number of questions presented to the participant of a questionnaire, when the question order is set to random.
  • Title: Response Order Code
    Maximum Length: 30
    Default Value: V
    Code that shows the ordering sequence for the answer choices in questions included in a questionnaire section. Valid values include V (Vertical) for presenting the answer choices in a question in the defined sequence and R (Random) for presenting answer choices in random order.
  • Title: Response Order
    Read Only: true
    Maximum Length: 80
    Meaning of the response order code.
  • Title: Section Id
    Read Only: true
    Surrogate identifier for the section in a questionnaire.
  • Title: Section Name
    Maximum Length: 240
    Name of the questionnaire section.
  • Title: Section Sequence Number
    Sequence number for a section in a questionnaire.
Nested Schema : Questions
Type: array
Title: Questions
The questions resource is a child of the questionnaires resource. It provides details of the questions included in a section of the questionnaire.
Show Source
Nested Schema : questionnaires-sections-questions-item-response
Type: object
Show Source
  • Title: Casual Question
    Read Only: true
    Maximum Length: 30
    Default Value: N
    Setting that indicates if the question added to the questionnaire is an informal or a casual question. This is a read-only attribute.
  • Title: Allow Additional Comments
    Read Only: true
    Maximum Length: 20
    Default Value: false
    Indicates whether a participant can provide additional comments while responding to a question. Valid values are Y and N. The default value is N.
  • Title: Allow Attachments
    Read Only: true
    Maximum Length: 30
    Default Value: false
    Indicates whether an attachment is allowed as a response to the question. The default value is N.
  • Answers
    Title: Answers
    The answers resource is a child of the questionnaires resource. It provides details of the answer choices defined for a question that's included in a questionnaire section.
  • Title: Conditional Display
    Read Only: true
    Maximum Length: 30
    Indicates whether a question conditionally displays. When this is set to Y, the controlling question code and controlling response are mandatory. The default value is N.
  • Title: Controlling Question Code
    Read Only: true
    Maximum Length: 240
    Answer to the controlling question that determines if the question displays or not.
  • Title: Controlling Answer Id
    Read Only: true
    Surrogate identifier of the controlling question. Required if the conditional display is set to Y.
  • Title: Controlling Question Code
    Read Only: true
    Maximum Length: 240
    Question code for the controlling question that determines if the question is presented to the participant to respond. Valid values are defined in the list questionsLOV.
  • Title: Controlling Question Id
    Read Only: true
    Surrogate identifier for the controlling question.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    Name of the user who added the question to the questionnaire section.
  • Title: Creation Date
    Read Only: true
    Date when the question was added to the questionnaire section.
  • Title: Instruction Text
    Read Only: true
    Maximum Length: 4000
    Instructions or additional information for the question.
  • Title: Last Update Date
    Read Only: true
    Date and time when the question was last updated in the questionnaire section.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    Date when the question was last updated in the questionnaire section.
  • Links
  • Title: Lock Question
    Read Only: true
    Maximum Length: 8
    Default Value: false
    Indicates whether you can remove or modify the question in the questionnaire. This is a read-only attribute. The default value is false.
  • Title: Mandatory
    Maximum Length: 30
    Default Value: false
    Indicates whether the response to this question is mandatory. Participants can't skip this question without an answer. The default value is false.
  • Title: Maximum Possible Score
    Read Only: true
    Maximum possible score which is the sum of the maximum possible scores of the possible answer choices. This can be zero if none of the answer choices have a positive score defined.
  • Title: Maximum Number of Selections
    Read Only: true
    Maximum number of answer choices that a participant can select when responding to a multiple choice question.
  • Title: Maximum Calculated Score
    Maximum score limit for the question when the total score is calculated for a response to the question.
  • Title: Minimum Number of Selections
    Read Only: true
    Minimum number of answer choices that a participant can select when responding to a multiple choice question.
  • Title: Minimum Calculated Score
    Minimum score limit for the question when the total score is calculated for a response to the question.
  • Attachments
    Title: Attachments
    The attachments resource is used to view, create, and update attachments.
  • Title: Question Code
    Maximum Length: 240
    Question code for the question used in the questionnaire template section. Valid values are defined in the list questionsLOV.
  • Title: Question ID
    Surrogate identifier of the question.
  • Title: Questionnaire Question ID
    Read Only: true
    Surrogate identifier of the question in the questionnaire.
  • Title: Question Text
    Read Only: true
    Maximum Length: 2000
    Question text for the question.
  • Title: Question Type Code
    Read Only: true
    Maximum Length: 30
    Default Value: TEXT
    Question type code indicating the type of the question.
  • Title: Question Type
    Read Only: true
    Maximum Length: 80
    Meaning of the question type code.
  • Title: Response Maximum Length
    Read Only: true
    Maximum Length: 20
    Maximum allowed length of responses for a text response type.
  • Title: Response Minimum Length
    Read Only: true
    Minimum expected length of responses for a text response type.
  • Title: Response Order Code
    Read Only: true
    Maximum Length: 30
    Code that shows if the question is enabled for random order. Possible values are Random to randomize the answer choices and Vertical to present the answer choices in the defined sequence.
  • Title: Response Order
    Read Only: true
    Maximum Length: 80
    Meaning of the response order code.
  • Title: Response Type Code
    Maximum Length: 30
    Response type for the question when presented to the participant. Valid values are defined in the questionnaireResponseTypesLOV.
  • Title: Response Type
    Read Only: true
    Maximum Length: 240
    Meaning of the response type code.
  • Title: Sample Size
    Read Only: true
    Number of answer choices presented to the participant when responding to a question that's enabled for randomization.
  • Title: Score Question
    Read Only: true
    Maximum Length: 30
    Default Value: false
    Indicates whether the question is used in calculating the score. The default value is N.
  • Title: Sequence Number
    Sequence number of the question in a questionnaire template section.
  • Title: Status Code
    Read Only: true
    Maximum Length: 30
    Default Value: D
    Status of the question. Valid values are A for Active, I for Inactive and D for Draft.
  • Title: Version Number
    Version number of the question in the questionnaire.
Nested Schema : Answers
Type: array
Title: Answers
The answers resource is a child of the questionnaires resource. It provides details of the answer choices defined for a question that's included in a questionnaire section.
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : questionnaires-sections-questions-answers-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : questionnaires-sections-questions-answers-answerAttachments-item-response
Type: object
Show Source
Nested Schema : questionnaires-sections-questions-questionAttachments-item-response
Type: object
Show Source
Links
attachments
Parameters:
  • questionnairesUniqID: $request.path.questionnairesUniqID
The attachments resource is a child of the questionnaires resource. It provides details of the attachments in a questionnaire.
calculationRuleLOV
Parameters:
  • finder: LookupTypeFinder%3BLookupType%3DORA_HRQ_QSTNR_CALC_RULE_TYPE
The following properties are defined on the LOV link relation:
  • Source Attribute: CalculationRule; Target Attribute: LookupCode
  • Display Attribute: LookupCode
hrqCategoriesLOV
The following properties are defined on the LOV link relation:
  • Source Attribute: FolderName; Target Attribute: Name
  • Display Attribute: Name
inUseLOV
Parameters:
  • finder: LookupTypeFinder%3BLookupType%3DHRQ_IN_USE
The following properties are defined on the LOV link relation:
  • Source Attribute: InUse; Target Attribute: LookupCode
  • Display Attribute: LookupCode
layoutOptionLOV
Parameters:
  • finder: LookupTypeFinder%3BLookupType%3DORA_HRQ_QSTNR_LAYOUT
The following properties are defined on the LOV link relation:
  • Source Attribute: LayoutOption; Target Attribute: LookupCode
  • Display Attribute: LookupCode
privacyLOV
Parameters:
  • finder: LookupTypeFinder%3BLookupType%3DHRQ_PRIVACY
The following properties are defined on the LOV link relation:
  • Source Attribute: PrivacyFlag; Target Attribute: LookupCode
  • Display Attribute: LookupCode
questionnaireTemplateLOV
The following properties are defined on the LOV link relation:
  • Source Attribute: QuestionnaireTemplateCode; Target Attribute: QstnrTemplateCode
  • Display Attribute: QstnrTemplateCode
sectionOrderLOV
Parameters:
  • finder: LookupTypeFinder%3BLookupType%3DHRQ_SECTION_ORDER
The following properties are defined on the LOV link relation:
  • Source Attribute: SectionOrder; Target Attribute: LookupCode
  • Display Attribute: LookupCode
sectionPresentationLOV
Parameters:
  • finder: LookupTypeFinder%3BLookupType%3DHRQ_SECTION_PRESENTATION
The following properties are defined on the LOV link relation:
  • Source Attribute: SectionPresentation; Target Attribute: LookupCode
  • Display Attribute: LookupCode
sections
Parameters:
  • questionnairesUniqID: $request.path.questionnairesUniqID
The sections resource is a child resource of the questionnaires resource. It provides details of the sections defined in the questionnaire.
statusLOV
Parameters:
  • finder: LookupTypeFinder%3BLookupType%3DHRQ_QUESTIONNAIRE_STATUS
The following properties are defined on the LOV link relation:
  • Source Attribute: Status; Target Attribute: LookupCode
  • Display Attribute: LookupCode
subscribersLOV
The following properties are defined on the LOV link relation:
  • Source Attribute: SubscriberCode; Target Attribute: SubscriberCode
  • Display Attribute: SubscriberCode
Back to Top