Jump to

• Request
• Response

Get all questionnaire templates

get

/hcmRestApi/resources/11.13.18.05/questionnaireTemplates

Request

Query Parameters

• effectiveDate: string
  This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
• 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 a questionnaire template that matches the specified primary key criteria.
    Finder Variables
    • QuestionnaireTemplateId; integer; Surrogate identifier for the questionnaire template.
• 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:
  

  • CreatedBy; string; Name of the user who created the questionnaire template.
  • CreationDate; string; Date when the questionnaire template was created.
  • Editor; string; Person Identifier of the person having the privileges to edit the questionnaire template marked as private.
  • EditorPersonName; string; Name of the person with privileges to edit the questionnaire template marked as private.
  • EditorPersonNumber; string; Person number of the person with privileges to edit the questionnaire template that's marked private.
  • InUseFlag; boolean; Indicates whether the questionnaire template is used by any questionnaires. The default value is false.
  • InUseMeaning; string; Meaning of the In Use Code attribute that Indicates whether the questionnaire template is used by any questionnaire.
  • InstructionText; string; Instructions or additional information for the questionnaire template.
  • LastUpdateDate; string; Date when the questionnaire template was last updated.
  • LastUpdatedBy; string; Name of the user who last updated the questionnaire template.
  • PrivacyFlag; boolean; Indicates whether the questionnaire template is private. If a template is marked private, only the person specified by the owner attribute can edit the template. The default value is false.
  • PrivacyMeaning; string; Meaning of the privacy code indicating if the questionnaire template is marked private.
  • QuestionnaireTemplateId; integer; Surrogate identifier for the questionnaire template.
  • QuestionnaireTemplateName; string; Name of the questionnaire template.
  • ScoreQuestionnaireFlag; boolean; Indicates whether the questionnaire is scored. The default value is false.
  • Status; string; Status of the questionnaire template.
  • StatusMeaning; string; Meaning of the status code for the questionnaire template.
  • SubscriberCode; string; Code for the subscriber using the questionnaire template. Valid values are defined in the list questionnaireSubscribersLOV.
  • SubscriberId; integer; Surrogate identifier for the subscriber.
  • SubscriberName; string; Name of the subscriber using the questionnaire template.
  • VersionNumber; integer; Version number of the questionnaire template.
• 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

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

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

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/questionnaireTemplates-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "isCompactViewByDefault":true
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object questionnaireTemplates-item-response

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

Type: object

Show Source

• AllowFormatChangeFlag: boolean
  Title: Allow changes to format options

  Maximum Length: 30

  Default Value: false

  Indicates whether the format options can be changed in the questionnaire. The default value is false.
• AllowInstrChangeFlag: boolean
  Title: Allow changes to instructions

  Maximum Length: 30

  Default Value: false

  Indicates whether the instructions can be changed in the questionnaire. The default value is false.
• AllowPlainTextFlag: boolean
  Title: Plain Text Box

  Indicates whether questions with plain text response type can be added to the questionnaire. The default value is false.
• AllowRichTextFlag: boolean
  Title: Rich Text Box

  Indicates whether questions with rich text response type can be added to the questionnaire. The default value is false.
• AllowSectionChangeFlag: boolean
  Title: Allow changes to sections

  Maximum Length: 30

  Default Value: false

  Indicates whether a section can be changed in the questionnaire. The default value is false.
• attachments: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• CalculationRule: string
  Title: Score Calculation Rule Code

  Read Only: true

  Maximum Length: 30

  Calculation rule code for questionnaires that are scored.
• CalculationRuleMeaning: string
  Title: Score Calculation Rule

  Read Only: true

  Maximum Length: 80

  Name of the score calculation rule for questionnaires that are scored.
• CheckBoxWithImageFlag: boolean
  Title: Check Box With Image

  Indicates whether questions with check box with image response type can be added to the questionnaire. The default value is true.
• CheckMultipleChoicesFlag: boolean
  Title: Check Multiple Choices

  Indicates whether questions with multiple choice check box response type can be added to the questionnaire. The default value is true.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  Name of the user who created the questionnaire template.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date when the questionnaire template was created.
• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 2000

  Description of the questionnaire template.
• Editor: string
  Title: Owner

  Read Only: true

  Maximum Length: 64

  Person Identifier of the person having the privileges to edit the questionnaire template marked as private.
• EditorPersonName: string
  Title: Person Name

  Read Only: true

  Maximum Length: 2000

  Name of the person with privileges to edit the questionnaire template marked as private.
• EditorPersonNumber: string
  Title: Person Number

  Read Only: true

  Maximum Length: 30

  Person number of the person with privileges to edit the questionnaire template that's marked private.
• InstructionText: string
  Title: Instruction Text

  Read Only: true

  Maximum Length: 4000

  Instructions or additional information for the questionnaire template.
• InUseFlag: boolean
  Title: In Use Code

  Read Only: true

  Maximum Length: 30

  Default Value: false

  Indicates whether the questionnaire template is used by any questionnaires. The default value is false.
• InUseMeaning: string
  Title: In Use

  Read Only: true

  Maximum Length: 80

  Meaning of the In Use Code attribute that Indicates whether the questionnaire template is used by any questionnaire.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Date when the questionnaire template was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  Name of the user who last updated the questionnaire template.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaximumPossibleScore: integer (int64)
  Title: Maximum Possible Score

  Read Only: true

  Sum of the maximum possible scores of all questions that are included in the questionnaire template.
• MultipleChoicesListFlag: boolean
  Title: Multiple Choices from List

  Indicates whether questions with multiple choice list response type can be added to the questionnaire.
• NoResponseFlag: boolean
  Title: No Response

  Indicates whether questions with no response type can be added to the questionnaire. The default value is true.
• PrivacyFlag: boolean
  Title: Privacy Code

  Read Only: true

  Maximum Length: 30

  Default Value: false

  Indicates whether the questionnaire template is private. If a template is marked private, only the person specified by the owner attribute can edit the template. The default value is false.
• PrivacyMeaning: string
  Title: Privacy

  Read Only: true

  Maximum Length: 80

  Meaning of the privacy code indicating if the questionnaire template is marked private.
• QuestionnaireTemplateId: integer (int64)
  Title: Questionnaire Template Id

  Read Only: true

  Surrogate identifier for the questionnaire template.
• QuestionnaireTemplateName: string
  Title: Questionnaire Template Name

  Maximum Length: 240

  Name of the questionnaire template.
• RadioButtonListFlag: boolean
  Title: Radio Button List

  Indicates whether questions with single choice radio button response type can be added to the questionnaire. The default value is true.
• RadioButtonWithImageFlag: boolean
  Title: Radio Button With Image

  Indicates whether questions with radio button with image response type can be added to the questionnaire. The default value is true.
• ScoreQuestionnaireFlag: boolean
  Title: Score Questionnaire

  Read Only: true

  Maximum Length: 30

  Indicates whether the questionnaire is scored. The default value is false.
• SectionOrderCode: string
  Title: Section Order Code

  Read Only: true

  Maximum Length: 30

  Default Value: S

  Code that shows the ordering sequence of the questionnaire sections.
• SectionOrderMeaning: string
  Title: Section Order

  Read Only: true

  Maximum Length: 80

  Meaning of the section order code indicating the sequencing order of the questionnaire sections.
• SectionPresentationCode: string
  Title: Section Presentation Code

  Read Only: true

  Maximum Length: 30

  Default Value: S

  Code that shows if the questionnaire is presented as stacked regions or without sections.
• SectionPresentationMeaning: string
  Title: Section Presentation

  Read Only: true

  Maximum Length: 80

  Meaning of the section presentation code indicating the presentation of sections of the questionnaire.
• sections: array Sections
  Title: Sections

  The sections resource is a child resource of the questionnaireTemplates resource that includes the details of the sections defined in the questionnaire template.
• SingleChoiceListFlag: boolean
  Title: Single Choice from List

  Indicates whether questions with single choice list response type can be added to the questionnaire. The default value is true.
• Status: string
  Title: Status Code

  Read Only: true

  Maximum Length: 30

  Default Value: D

  Status of the questionnaire template.
• StatusMeaning: string
  Title: Status

  Read Only: true

  Maximum Length: 80

  Meaning of the status code for the questionnaire template.
• SubscriberCode: string
  Title: Subscriber Code

  Read Only: true

  Maximum Length: 30

  Code for the subscriber using the questionnaire template. Valid values are defined in the list questionnaireSubscribersLOV.
• SubscriberId: integer (int64)
  Title: Subscriber Id

  Read Only: true

  Surrogate identifier for the subscriber.
• SubscriberName: string
  Title: Subscriber Name

  Read Only: true

  Maximum Length: 240

  Name of the subscriber using the questionnaire template.
• VersionDescription: string
  Title: Version Description

  Read Only: true

  Maximum Length: 2000

  Description provided when a new version of a questionnaire template is created.
• VersionNumber: integer (int64)
  Title: Version Number

  Read Only: true

  Default Value: 1

  Version number of the questionnaire template.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the questionnaire template was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"2000",
            "type":"string",
            "description":"Description of the questionnaire template.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/questionnaireTemplates-attachments-item-response"
            }
        },
        "EditorPersonNumber":{
            "title":"Person Number",
            "maxLength":"30",
            "type":"string",
            "description":"Person number of the person with privileges to edit the questionnaire template that's marked private.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AllowRichTextFlag":{
            "title":"Rich Text Box",
            "type":"boolean",
            "description":"Indicates whether questions with rich text response type can be added to the questionnaire. The default value is false.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "PrivacyFlag":{
            "title":"Privacy Code",
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates whether the questionnaire template is private. If a template is marked private, only the person specified by the owner attribute can edit the template. The default value is false.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "fnd:OA_TRANSLATABLE":"false"
            },
            "x-queryable":true
        },
        "MaximumPossibleScore":{
            "title":"Maximum Possible Score",
            "type":"integer",
            "description":"Sum of the maximum possible scores of all questions that are included in the questionnaire template.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ScoreQuestionnaireFlag":{
            "title":"Score Questionnaire",
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates whether the questionnaire is scored. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "EditorPersonName":{
            "title":"Person Name",
            "maxLength":"2000",
            "type":"string",
            "description":"Name of the person with privileges to edit the questionnaire template marked as private.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SectionPresentationMeaning":{
            "title":"Section Presentation",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of the section presentation code indicating the presentation of sections of the questionnaire.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "RadioButtonListFlag":{
            "title":"Radio Button List",
            "type":"boolean",
            "description":"Indicates whether questions with single choice radio button response type can be added to the questionnaire. The default value is true.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "InstructionText":{
            "title":"Instruction Text",
            "maxLength":"4000",
            "type":"string",
            "description":"Instructions or additional information for the questionnaire template.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubscriberId":{
            "title":"Subscriber Id",
            "type":"integer",
            "description":"Surrogate identifier for the subscriber.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "CalculationRuleMeaning":{
            "title":"Score Calculation Rule",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the score calculation rule for questionnaires that are scored.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SubscriberName":{
            "title":"Subscriber Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the subscriber using the questionnaire template.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MultipleChoicesListFlag":{
            "title":"Multiple Choices from List",
            "type":"boolean",
            "description":"Indicates whether questions with multiple choice list response type can be added to the questionnaire.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "InUseMeaning":{
            "title":"In Use",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of the In Use Code attribute that Indicates whether the questionnaire template is used by any questionnaire.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AllowInstrChangeFlag":{
            "title":"Allow changes to instructions",
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates whether the instructions can be changed in the questionnaire. The default value is false.",
            "nullable":false,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Status":{
            "title":"Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"Status of the questionnaire template.",
            "nullable":false,
            "readOnly":true,
            "default":"D",
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"Name of the user who last updated the questionnaire template.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "VersionDescription":{
            "title":"Version Description",
            "maxLength":"2000",
            "type":"string",
            "description":"Description provided when a new version of a questionnaire template is created.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"Name of the user who created the questionnaire template.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InUseFlag":{
            "title":"In Use Code",
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates whether the questionnaire template is used by any questionnaires. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "RadioButtonWithImageFlag":{
            "title":"Radio Button With Image",
            "type":"boolean",
            "description":"Indicates whether questions with radio button with image response type can be added to the questionnaire. The default value is true.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "VersionNumber":{
            "title":"Version Number",
            "type":"integer",
            "description":"Version number of the questionnaire template.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "default":"1",
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "AllowFormatChangeFlag":{
            "title":"Allow changes to format options",
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates whether the format options can be changed in the questionnaire. The default value is false.",
            "nullable":false,
            "default":false,
            "x-queryable":false
        },
        "sections":{
            "title":"Sections",
            "type":"array",
            "description":"The sections resource is a child resource of the questionnaireTemplates resource that includes the details of the sections defined in the questionnaire template.",
            "items":{
                "$ref":"#/components/schemas/questionnaireTemplates-sections-item-response"
            }
        },
        "CalculationRule":{
            "title":"Score Calculation Rule Code",
            "maxLength":"30",
            "type":"string",
            "description":"Calculation rule code for questionnaires that are scored.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            }
        },
        "CheckBoxWithImageFlag":{
            "title":"Check Box With Image",
            "type":"boolean",
            "description":"Indicates whether questions with check box with image response type can be added to the questionnaire. The default value is true.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "StatusMeaning":{
            "title":"Status",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of the status code for the questionnaire template.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "QuestionnaireTemplateId":{
            "title":"Questionnaire Template Id",
            "type":"integer",
            "description":"Surrogate identifier for the questionnaire template.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "SubscriberCode":{
            "title":"Subscriber Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code for the subscriber using the questionnaire template. Valid values are defined in the list questionnaireSubscribersLOV.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SingleChoiceListFlag":{
            "title":"Single Choice from List",
            "type":"boolean",
            "description":"Indicates whether questions with single choice list response type can be added to the questionnaire. The default value is true.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "SectionPresentationCode":{
            "title":"Section Presentation Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code that shows if the questionnaire is presented as stacked regions or without sections.",
            "nullable":true,
            "readOnly":true,
            "default":"S",
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "fnd:OA_TRANSLATABLE":"false"
            }
        },
        "AllowSectionChangeFlag":{
            "title":"Allow changes to sections",
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates whether a section can be changed in the questionnaire. The default value is false.",
            "nullable":false,
            "default":false,
            "x-queryable":false
        },
        "AllowPlainTextFlag":{
            "title":"Plain Text Box",
            "type":"boolean",
            "description":"Indicates whether questions with plain text response type can be added to the questionnaire. The default value is false.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "CheckMultipleChoicesFlag":{
            "title":"Check Multiple Choices",
            "type":"boolean",
            "description":"Indicates whether questions with multiple choice check box response type can be added to the questionnaire. The default value is true.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "SectionOrderMeaning":{
            "title":"Section Order",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of the section order code indicating the sequencing order of the questionnaire sections.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Editor":{
            "title":"Owner",
            "maxLength":"64",
            "type":"string",
            "description":"Person Identifier of the person having the privileges to edit the questionnaire template marked as private.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:OA_TRANSLATABLE":"false"
            },
            "x-queryable":true
        },
        "QuestionnaireTemplateName":{
            "title":"Questionnaire Template Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the questionnaire template.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PrivacyMeaning":{
            "title":"Privacy",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of the privacy code indicating if the questionnaire template is marked private.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SectionOrderCode":{
            "title":"Section Order Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code that shows the ordering sequence of the questionnaire sections.",
            "nullable":true,
            "readOnly":true,
            "default":"S",
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "fnd:OA_TRANSLATABLE":"false"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date when the questionnaire template was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NoResponseFlag":{
            "title":"No Response",
            "type":"boolean",
            "description":"Indicates whether questions with no response type can be added to the questionnaire. The default value is true.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is used to view, create, and update attachments.

Show Source

• Array of: object questionnaireTemplates-attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/questionnaireTemplates-attachments-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 : Sections

Type: array

Title: Sections

The sections resource is a child resource of the questionnaireTemplates resource that includes the details of the sections defined in the questionnaire template.

Show Source

• Array of: object questionnaireTemplates-sections-item-response

{
    "title":"Sections",
    "type":"array",
    "description":"The sections resource is a child resource of the questionnaireTemplates resource that includes the details of the sections defined in the questionnaire template.",
    "items":{
        "$ref":"#/components/schemas/questionnaireTemplates-sections-item-response"
    }
}

Nested Schema : questionnaireTemplates-attachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  The unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  The user who created the record.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  The user name who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI of the file.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  The base64 encoded image of the file displayed in .png format if the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  The user who last updated the record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  The user name who last updated the record.
• links: array Links
  Title: Links

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

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The login credentials of the user who created the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":"255",
            "type":"string",
            "description":"The login credentials of the user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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."
        }
    }
}

Nested Schema : questionnaireTemplates-sections-item-response

Type: object

Show Source

• AllowAdditionalQuestionsFlag: boolean
  Title: Allow Additional Questions

  Maximum Length: 30

  Default Value: false

  Indicates whether additional questions can be added to the questionnaire section when a response is requested. The default value is false.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  Name of the user who created the section.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date when the section was created.
• Description: string
  Title: Description

  Maximum Length: 2000

  Description of the questionnaire section.
• IntroText: string
  Title: Introduction

  Maximum Length: 2000

  Introduction text for the questionnaire section.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Date when the section was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  Name of the user who last updated the section.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MandatoryFlag: boolean
  Title: Required

  Maximum Length: 30

  Default Value: false

  Indicates whether the questionnaire section is mandatory. The default value is false.
• QuestionOrder: string
  Title: Question Order Code

  Maximum Length: 30

  Default Value: V

  Indicates the ordering sequence for the questions in a questionnaire section.
• QuestionOrderMeaning: string
  Title: Question Order

  Read Only: true

  Maximum Length: 80

  Meaning of the question order code indicating the ordering sequence for the questions in a questionnaire section.
• questions: array Questions
  Title: Questions

  The questions resource is a child of the questionnaireTemplates resource. It includes details of the questions included in a section of the questionnaire template.
• ResponseOrder: string
  Title: Response Order Code

  Maximum Length: 30

  Default Value: V

  Indicates the ordering sequence for the answer choices in questions included in a questionnaire section.
• ResponseOrderMeaning: string
  Title: Response Order

  Read Only: true

  Maximum Length: 80

  Meaning of the response order code indicating the ordering sequence for the answer choices in questions.
• SectionId: integer (int64)
  Title: Section Id

  Read Only: true

  Surrogate identifier for the section in a questionnaire template.
• SectionName: string
  Title: Section Name

  Maximum Length: 240

  Name of the questionnaire section.
• SectionSequenceNumber: integer (int64)
  Title: Section Sequence Number

  Sequence number for a section in a questionnaire template.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"Name of the user who last updated the section.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the section was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"Name of the user who created the section.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"2000",
            "type":"string",
            "description":"Description of the questionnaire section.",
            "nullable":true,
            "x-queryable":false
        },
        "ResponseOrder":{
            "title":"Response Order Code",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the ordering sequence for the answer choices in questions included in a questionnaire section.",
            "nullable":true,
            "default":"V",
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            }
        },
        "questions":{
            "title":"Questions",
            "type":"array",
            "description":"The questions resource is a child of the questionnaireTemplates resource. It includes details of the questions included in a section of the questionnaire template.",
            "items":{
                "$ref":"#/components/schemas/questionnaireTemplates-sections-questions-item-response"
            }
        },
        "AllowAdditionalQuestionsFlag":{
            "title":"Allow Additional Questions",
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates whether additional questions can be added to the questionnaire section when a response is requested. The default value is false.",
            "nullable":true,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "MandatoryFlag":{
            "title":"Required",
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates whether the questionnaire section is mandatory. The default value is false.",
            "nullable":true,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ResponseOrderMeaning":{
            "title":"Response Order",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of the response order code indicating the ordering sequence for the answer choices in questions.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "QuestionOrderMeaning":{
            "title":"Question Order",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of the question order code indicating the ordering sequence for the questions in a questionnaire section.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SectionName":{
            "title":"Section Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the questionnaire section.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SectionSequenceNumber":{
            "title":"Section Sequence Number",
            "type":"integer",
            "description":"Sequence number for a section in a questionnaire template.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            }
        },
        "QuestionOrder":{
            "title":"Question Order Code",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the ordering sequence for the questions in a questionnaire section.",
            "nullable":true,
            "default":"V",
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            }
        },
        "SectionId":{
            "title":"Section Id",
            "type":"integer",
            "description":"Surrogate identifier for the section in a questionnaire template.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "IntroText":{
            "title":"Introduction",
            "maxLength":"2000",
            "type":"string",
            "description":"Introduction text for the questionnaire section.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date when the section was last updated.",
            "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 : Questions

Type: array

Title: Questions

The questions resource is a child of the questionnaireTemplates resource. It includes details of the questions included in a section of the questionnaire template.

Show Source

• Array of: object questionnaireTemplates-sections-questions-item-response

{
    "title":"Questions",
    "type":"array",
    "description":"The questions resource is a child of the questionnaireTemplates resource. It includes details of the questions included in a section of the questionnaire template.",
    "items":{
        "$ref":"#/components/schemas/questionnaireTemplates-sections-questions-item-response"
    }
}

Nested Schema : questionnaireTemplates-sections-questions-item-response

Type: object

Show Source

• AllowAdditionalCommentsFlag: boolean
  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.
• answers: array Answers
  Title: Answers

  The answers resource is a child of the questionnaireTemplates resource. It includes details of the answer choices defined for a question that's included in a questionnaire template section.
• ControllingQuestionCode: string
  Title: Question Code

  Read Only: true

  Maximum Length: 240

  Question code for the controlling question that determines if the question is to be presented to the participant to respond. Valid values are defined in the list questionsLOV.
• ControllingQuestionId: integer (int64)
  Title: Controlling Question Id

  Read Only: true

  Surrogate identifier for the controlling question.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  Name of the user who added the question to the questionnaire template section.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date when the question was added to the questionnaire template section.
• InstructionsText: string
  Title: Instruction Text

  Read Only: true

  Maximum Length: 4000

  Instructions or additional information for the question.
• KeepWithPreviousFlag: boolean
  Title: Keep with Previous

  Maximum Length: 30

  Default Value: false

  Indicates whether the question is always paired with the previous question even when the question order is randomized. The default value is false.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Date when the question was last updated in the questionnaire template section.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  Name of the user who last updated the question in the questionnaire template section.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LockQuestionFlag: boolean
  Title: Lock Question

  Maximum Length: 8

  Default Value: false

  Indicates whether the question can be removed or modified in the questionnaire. The default value is false.
• MandatoryFlag: boolean
  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.
• MaximumPossibleScore: integer (int64)
  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.
• QuestionCode: string
  Title: Question Code

  Read Only: true

  Maximum Length: 240

  Question code for the question used in the questionnaire template section. Valid values are defined in the list questionsLOV.
• QuestionId: integer (int64)
  Title: Question Id

  Read Only: true

  Surrogate identifier for the question.
• QuestionnaireQuestionId: integer (int64)
  Title: Questionnaire Question Id

  Read Only: true

  Surrogate identifier of the question in the questionnaire.
• QuestionText: string
  Title: Question Text

  Read Only: true

  Maximum Length: 2000

  Question text for the question.
• QuestionType: string
  Title: Question Type Code

  Read Only: true

  Maximum Length: 30

  Default Value: TEXT

  Question type code indicating the type of the question.
• QuestionTypeMeaning: string
  Title: Question Type

  Read Only: true

  Maximum Length: 80

  Meaning of the question type code.
• QuestionVersionNumber: integer (int64)
  Title: Version Number

  Version number of the question used in the questionnaire template section.
• ResponseOrderCode: string
  Title: Response Order Code

  Read Only: true

  Maximum Length: 30

  Code that shows whether 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.
• ResponseOrderMeaning: string
  Title: Response Order

  Read Only: true

  Maximum Length: 80

  Meaning of the response order code.
• ResponseType: string
  Title: Response Type Code

  Response type for the question when presented to the participant. Valid values are defined in the questionnaireResponseTypesLOV.
• ResponseTypeMeaning: string
  Title: Response Type

  Read Only: true

  Meaning of the response type code.
• SampleSize: integer (int64)
  Title: Sample Size

  Read Only: true

  Defines the number of questions presented to the participant of a questionnaire, when the question order is set to random.
• SequenceNumber: integer (int64)
  Title: Sequence Number

  Sequence number of the question in a questionnaire template section.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the question was added to the questionnaire template section.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResponseOrderCode":{
            "title":"Response Order Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code that shows whether 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.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "answers":{
            "title":"Answers",
            "type":"array",
            "description":"The answers resource is a child of the questionnaireTemplates resource. It includes details of the answer choices defined for a question that's included in a questionnaire template section.",
            "items":{
                "$ref":"#/components/schemas/questionnaireTemplates-sections-questions-answers-item-response"
            }
        },
        "ResponseTypeMeaning":{
            "title":"Response Type",
            "type":"string",
            "description":"Meaning of the response type code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "MaximumPossibleScore":{
            "title":"Maximum Possible Score",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "MandatoryFlag":{
            "title":"Mandatory",
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates whether the response to this question is mandatory. Participants can't skip this question without an answer. The default value is false.",
            "nullable":true,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "QuestionnaireQuestionId":{
            "title":"Questionnaire Question Id",
            "type":"integer",
            "description":"Surrogate identifier of the question in the questionnaire.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "QuestionCode":{
            "title":"Question Code",
            "maxLength":"240",
            "type":"string",
            "description":"Question code for the question used in the questionnaire template section. Valid values are defined in the list questionsLOV.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ResponseOrderMeaning":{
            "title":"Response Order",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of the response order code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "KeepWithPreviousFlag":{
            "title":"Keep with Previous",
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates whether the question is always paired with the previous question even when the question order is randomized. The default value is false.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "AllowAdditionalCommentsFlag":{
            "title":"Allow Additional Comments",
            "maxLength":"20",
            "type":"boolean",
            "description":"Indicates whether a participant can provide additional comments while responding to a question. Valid values are Y and N. The default value is N.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "SequenceNumber":{
            "title":"Sequence Number",
            "type":"integer",
            "description":"Sequence number of the question in a questionnaire template section.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "InstructionsText":{
            "title":"Instruction Text",
            "maxLength":"4000",
            "type":"string",
            "description":"Instructions or additional information for the question.",
            "nullable":true,
            "readOnly":true,
            "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":"Question text for the question.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ControllingQuestionCode":{
            "title":"Question Code",
            "maxLength":"240",
            "type":"string",
            "description":"Question code for the controlling question that determines if the question is to be presented to the participant to respond. Valid values are defined in the list questionsLOV.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"Name of the user who last updated the question in the questionnaire template section.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LockQuestionFlag":{
            "title":"Lock Question",
            "maxLength":"8",
            "type":"boolean",
            "description":"Indicates whether the question can be removed or modified in the questionnaire. The default value is false.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "ControllingQuestionId":{
            "title":"Controlling Question Id",
            "type":"integer",
            "description":"Surrogate identifier for the controlling question.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"Name of the user who added the question to the questionnaire template section.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "QuestionTypeMeaning":{
            "title":"Question Type",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of the question type code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "QuestionType":{
            "title":"Question Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Question type code indicating the type of the question.",
            "nullable":false,
            "readOnly":true,
            "default":"TEXT",
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ResponseType":{
            "title":"Response Type Code",
            "type":"string",
            "description":"Response type for the question when presented to the participant. Valid values are defined in the questionnaireResponseTypesLOV.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SampleSize":{
            "title":"Sample Size",
            "type":"integer",
            "description":"Defines the number of questions presented to the participant of a questionnaire, when the question order is set to random.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "QuestionVersionNumber":{
            "title":"Version Number",
            "type":"integer",
            "description":"Version number of the question used in the questionnaire template section.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "QuestionId":{
            "title":"Question Id",
            "type":"integer",
            "description":"Surrogate identifier for the question.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date when the question was last updated in the questionnaire template section.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Answers

Type: array

Title: Answers

The answers resource is a child of the questionnaireTemplates resource. It includes details of the answer choices defined for a question that's included in a questionnaire template section.

Show Source

• Array of: object questionnaireTemplates-sections-questions-answers-item-response

{
    "title":"Answers",
    "type":"array",
    "description":"The answers resource is a child of the questionnaireTemplates resource. It includes details of the answer choices defined for a question that's included in a questionnaire template section.",
    "items":{
        "$ref":"#/components/schemas/questionnaireTemplates-sections-questions-answers-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 : questionnaireTemplates-sections-questions-answers-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• QuestionAnswerId: integer (int64)
  Title: Question Answer Id

  Surrogate identifier for the answer choice defined for a question.
• ResponseCode: string
  Title: Response Code

  Maximum Length: 240

  Unique code for the answer choice defined for a question.
• ResponseFeedback: string (byte)
  Title: Response Feedback

  Feedback provided to the participant when the answer choice is selected.
• Score: integer (int64)
  Title: Score

  Score for the answer.
• ShortDescription: string
  Title: Short Description

  Maximum Length: 240

  Answer text for the answer choices of a question.

{
    "type":"object",
    "properties":{
        "ResponseFeedback":{
            "title":"Response Feedback",
            "type":"string",
            "description":"Feedback provided to the participant when the answer choice is selected.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ResponseCode":{
            "title":"Response Code",
            "maxLength":"240",
            "type":"string",
            "description":"Unique code for the answer choice defined for a question.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Score":{
            "title":"Score",
            "type":"integer",
            "description":"Score for the answer.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            }
        },
        "QuestionAnswerId":{
            "title":"Question Answer Id",
            "type":"integer",
            "description":"Surrogate identifier for the answer choice defined for a question.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "ShortDescription":{
            "title":"Short Description",
            "maxLength":"240",
            "type":"string",
            "description":"Answer text for the answer choices of a question.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":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"
    }
}

Back to Top