Jump to

• Request
• Response

Get all questionnaires

get

/hcmRestApi/resources/11.13.18.05/questionnaires

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 the questionnaires that match the primary key criteria.
    Finder Variables
    • QuestionnaireId; integer; Surrogate identifier of the questionnaire.
    • VersionNumber; integer; Version number of the questionnaire.
• 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.
  • CreationDate; string; Date when the questionnaire was created.
  • Editor; string; Name of the person with privileges to edit the questionnaire marked as private.
  • EditorPersonNumber; string; Person number of the person with privileges to edit the questionnaire marked as private.
  • FolderId; integer; Surrogate identifier of the category or folder where the questionnaire is stored.
  • FolderName; string; Name of the category or folder where the questionnaire is stored.
  • InUse; string; Code that shows whether the participants have already responded to the questionnaire.
  • InUseMeaning; string; Meaning of the In Use code.
  • InstructionText; string; Instructions or additional information for the questionnaire.
  • LastUpdateDate; string; Date when the questionnaire was last updated.
  • LastUpdatedBy; string; Name of the user who last updated the questionnaire.
  • LatestVersionFlag; boolean; Setting that indicates if this is the latest version of the questionnaire. This is a read-only attribute.
  • PrivacyFlag; boolean; 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.
  • PrivacyMeaning; string; Meaning of the privacy code indicating if the questionnaire is marked private.
  • QuestionnaireCode; string; Alphanumeric code that uniquely identifies a questionnaire defined for a subscriber.
  • QuestionnaireId; integer; Surrogate identifier of the questionnaire.
  • QuestionnaireName; string; Name of the questionnaire.
  • QuestionnaireTemplateCode; string; Alphanumeric value that uniquely identifies the questionnaire template referred to by the questionnaire.
  • QuestionnaireTemplateId; integer; Surrogate identifier of the questionnaire template.
  • QuestionnaireTemplateName; string; Name of the questionnaire template.
  • ScoreQuestionnaireFlag; boolean; Setting that indicates if the questionnaire is scored. This is a read-only attribute.
  • Status; string; Status of the questionnaire. Valid values include A (Active), I (Inactive) and D (Draft).
  • StatusMeaning; string; Meaning of the status code.
  • SubscriberCode; string; Code for the subscriber using the questionnaire. 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. Version Number should be 1 when a new questionnaire is created.
• 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 : questionnaires

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/questionnaires-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 questionnaires-item-response

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

Type: object

Show Source

• attachments: array Attachments
  Title: Attachments

  The attachments resource is a child of the questionnaires resource. It provides details of the attachments in a questionnaire.
• CalculationRule: string
  Title: Score Calculation Rule Code

  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.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

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

  Maximum Length: 2000

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

  Maximum Length: 64

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

  Maximum Length: 30

  Person number of the person with privileges to edit the questionnaire marked as private.
• FolderId: integer (int64)
  Title: Folder Id

  Surrogate identifier of the category or folder where the questionnaire is stored.
• FolderName: string
  Title: Folder Name

  Maximum Length: 240

  Name of the category or folder where the questionnaire is stored.
• InstructionText: string
  Title: Instruction Text

  Maximum Length: 4000

  Instructions or additional information for the questionnaire.
• InUse: string
  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.
• InUseMeaning: string
  Title: In Use

  Read Only: true

  Maximum Length: 80

  Meaning of the In Use code.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

  Name of the user who last updated the questionnaire.
• LatestVersionFlag: boolean
  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.
• LayoutOption: string
  Title: Display Format

  Maximum Length: 30

  Presentation format for questions in a questionnaire. This configuration is only available for Touchpoints subscribers.
• LayoutOptionMeaning: string
  Title: Display Format

  Read Only: true

  Maximum Length: 80

  Meaning of the display format code for the questionnaire.
• 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.
• PrivacyFlag: boolean
  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.
• PrivacyMeaning: string
  Title: Privacy

  Read Only: true

  Maximum Length: 80

  Meaning of the privacy code indicating if the questionnaire is marked private.
• QuestionnaireCode: string
  Title: Questionnaire Code

  Maximum Length: 240

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

  Surrogate identifier of the questionnaire.
• QuestionnaireName: string
  Title: Questionnaire Name

  Maximum Length: 240

  Name of the questionnaire.
• QuestionnaireTemplateCode: string
  Title: Questionnaire Code

  Maximum Length: 240

  Alphanumeric value that uniquely identifies the questionnaire template referred to by the questionnaire.
• QuestionnaireTemplateId: integer (int64)
  Title: Questionnaire Template ID

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

  Read Only: true

  Maximum Length: 240

  Name of the questionnaire template.
• ScoreQuestionnaireFlag: boolean
  Title: Score Questionnaire

  Read Only: true

  Maximum Length: 30

  Setting that indicates if the questionnaire is scored. This is a read-only attribute.
• SectionOrder: string
  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.
• SectionOrderMeaning: string
  Title: Section Order

  Read Only: true

  Maximum Length: 80

  Meaning of the section order code.
• SectionPresentation: string
  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.
• SectionPresentationMeaning: string
  Title: Section Presentation

  Read Only: true

  Maximum Length: 80

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

  The sections resource is a child resource of the questionnaires resource. It provides details of the sections defined in the questionnaire.
• Status: string
  Title: Status Code

  Maximum Length: 30

  Default Value: D

  Status of the questionnaire. Valid values include A (Active), I (Inactive) and D (Draft).
• StatusMeaning: string
  Title: Status

  Read Only: true

  Maximum Length: 80

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

  Maximum Length: 30

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

  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

  Maximum Length: 2000

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

  Default Value: 1

  Version number of the questionnaire. Version Number should be 1 when a new questionnaire is created.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the questionnaire was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":2000,
            "type":"string",
            "description":"Description of the questionnaire.",
            "nullable":true,
            "x-queryable":false
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is a child of the questionnaires resource. It provides details of the attachments in a questionnaire.",
            "items":{
                "$ref":"#/components/schemas/questionnaires-attachments-item-response"
            }
        },
        "EditorPersonNumber":{
            "title":"Person Number",
            "maxLength":30,
            "type":"string",
            "description":"Person number of the person with privileges to edit the questionnaire marked as private.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PrivacyFlag":{
            "title":"Privacy Code",
            "maxLength":30,
            "type":"boolean",
            "description":"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.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"choice",
                "fnd:OA_TRANSLATABLE":"false"
            },
            "x-queryable":true
        },
        "LatestVersionFlag":{
            "title":"Latest Version",
            "maxLength":30,
            "type":"boolean",
            "description":"Setting that indicates if this is the latest version of the questionnaire. This is a read-only attribute.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "FolderName":{
            "title":"Folder Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the category or folder where the questionnaire is stored.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "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.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ScoreQuestionnaireFlag":{
            "title":"Score Questionnaire",
            "maxLength":30,
            "type":"boolean",
            "description":"Setting that indicates if the questionnaire is scored. This is a read-only attribute.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SectionPresentationMeaning":{
            "title":"Section Presentation",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of the section presentation code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "InstructionText":{
            "title":"Instruction Text",
            "maxLength":4000,
            "type":"string",
            "description":"Instructions or additional information for the questionnaire.",
            "nullable":true,
            "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
        },
        "SubscriberId":{
            "title":"Subscriber Id",
            "type":"integer",
            "description":"Surrogate identifier for the subscriber.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "SubscriberName":{
            "title":"Subscriber Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the subscriber using the questionnaire template.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "QuestionnaireId":{
            "title":"Questionnaire Id",
            "type":"integer",
            "description":"Surrogate identifier of the questionnaire.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "QuestionnaireTemplateCode":{
            "title":"Questionnaire Code",
            "maxLength":240,
            "type":"string",
            "description":"Alphanumeric value that uniquely identifies the questionnaire template referred to by the questionnaire.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "QuestionnaireName":{
            "title":"Questionnaire Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the questionnaire.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "InUseMeaning":{
            "title":"In Use",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of the In Use code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SectionPresentation":{
            "title":"Section Presentation Code",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "default":"S",
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "fnd:OA_TRANSLATABLE":"false"
            }
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who last updated the questionnaire.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "description":"Status of the questionnaire. Valid values include A (Active), I (Inactive) and D (Draft).",
            "nullable":false,
            "default":"D",
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who created the questionnaire.",
            "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 is created.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "SectionOrder":{
            "title":"Section Order Code",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "default":"S",
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "fnd:OA_TRANSLATABLE":"false"
            }
        },
        "FolderId":{
            "title":"Folder Id",
            "type":"integer",
            "description":"Surrogate identifier of the category or folder where the questionnaire is stored.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "LayoutOption":{
            "title":"Display Format",
            "maxLength":30,
            "type":"string",
            "description":"Presentation format for questions in a questionnaire. This configuration is only available for Touchpoints subscribers.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            }
        },
        "VersionNumber":{
            "title":"Version Number",
            "type":"integer",
            "description":"Version number of the questionnaire. Version Number should be 1 when a new questionnaire is created.",
            "format":"int64",
            "nullable":false,
            "default":1,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "sections":{
            "title":"Sections",
            "type":"array",
            "description":"The sections resource is a child resource of the questionnaires resource. It provides details of the sections defined in the questionnaire.",
            "items":{
                "$ref":"#/components/schemas/questionnaires-sections-item-response"
            }
        },
        "CalculationRule":{
            "title":"Score Calculation Rule Code",
            "maxLength":30,
            "type":"string",
            "description":"Calculation rule code for questionnaires that are scored.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            }
        },
        "StatusMeaning":{
            "title":"Status",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of the status code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "QuestionnaireTemplateId":{
            "title":"Questionnaire Template ID",
            "type":"integer",
            "description":"Surrogate identifier of the questionnaire template.",
            "format":"int64",
            "nullable":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. Valid values are defined in the list questionnaireSubscribersLOV.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "InUse":{
            "title":"In Use Code",
            "maxLength":30,
            "type":"string",
            "description":"Code that shows whether the participants have already responded to the questionnaire.",
            "nullable":true,
            "readOnly":true,
            "default":"N",
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "SectionOrderMeaning":{
            "title":"Section Order",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of the section order code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LayoutOptionMeaning":{
            "title":"Display Format",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of the display format code for the questionnaire.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Editor":{
            "title":"Owner",
            "maxLength":64,
            "type":"string",
            "description":"Name of the person with privileges to edit the questionnaire marked as private.",
            "nullable":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,
            "readOnly":true,
            "x-queryable":true
        },
        "PrivacyMeaning":{
            "title":"Privacy",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of the privacy code indicating if the questionnaire is marked private.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date when the questionnaire was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "QuestionnaireCode":{
            "title":"Questionnaire Code",
            "maxLength":240,
            "type":"string",
            "description":"Alphanumeric code that uniquely identifies a questionnaire defined for a subscriber.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        }
    }
}

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

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

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is a child of the questionnaires resource. It provides details of the attachments in a questionnaire.",
    "items":{
        "$ref":"#/components/schemas/questionnaires-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 questionnaires resource. It provides details of the sections defined in the questionnaire.

Show Source

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

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

Nested Schema : questionnaires-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

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

  Maximum Length: 30

  Category name of the attachment. This is a read-only attribute.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Content repository file shared. This is a read-only attribute.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  User who created the attachment.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  User name of the user who created the attachment.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date when the attachment was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  Attachment type such as file, text or web page.
• Description: string
  Title: Description

  Maximum Length: 255

  Description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  Surrogate identifier of the document attached to the questionnaire.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Path of the folder.
• DmVersionNumber: string
  Maximum Length: 255

  Version number of the attachment.
• DownloadInfo: string
  Title: DownloadInfo

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

  Error status code of the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  Error status message of the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  Expiration date of the attachment. This is a read-only attribute.
• FileContents: string (byte)
  Title: File Contents

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

  Maximum Length: 2048

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

  File URL of the attachment.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 255

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

  Read Only: true

  User name of the person who last updated the attachment.
• 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

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

  Content type of the uploaded file. This is a read-only attribute.
• UploadedFileLength: integer
  Title: File Size

  Size of the uploaded file. This is a read-only attribute.
• UploadedFileName: string
  Title: Uploaded File Name

  Name of the uploaded file. This is a read-only attribute.
• UploadedText: string
  Title: Uploaded Text

  Text uploaded in the attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  URI of the attachment. This is a read-only attribute.
• Url: string
  Title: Url

  Maximum Length: 4000

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

  Read Only: true

  Maximum Length: 255

  User name of the person who uploaded the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the attachment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"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":"Name of the attachment file.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"Base64 encoded image of the file displayed in .png format when 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":"URI of the attachment. This is a read-only attribute.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"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":"Surrogate identifier of the document attached to the questionnaire.",
            "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":"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":"Content type of the uploaded file. This is a read-only attribute.",
            "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 that contains 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":"User name of the user who created the attachment.",
            "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":"Size of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Version number of the attachment.",
            "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":"Name of the user who last updated the attachment record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Error status message of 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":"User name of the person who uploaded 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":"User who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Attachment type such as file, text or web page.",
            "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":"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":"User name of the person who last updated the attachment.",
            "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":"Name of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"File URL of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Content repository file shared. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"File contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Expiration date of the attachment. This is a read-only attribute.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Error status code of 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":"Path of the folder.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text uploaded in the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Category name of the attachment. This is a read-only attribute.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date when the attachment 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 : questionnaires-sections-item-response

Type: object

Show Source

• AllowAdditionalQuestionsFlag: boolean
  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.
• 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.
• Mandatory: string
  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.
• QuestionOrder: string
  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.
• QuestionOrderMeaning: string
  Title: Question Order

  Read Only: true

  Maximum Length: 80

  Meaning of the question order code.
• questions: array 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.
• RandomSampleSize: integer (int64)
  Title: Sample Size

  Defines the number of questions presented to the participant of a questionnaire, when the question order is set to random.
• ResponseOrder: string
  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.
• ResponseOrderMeaning: string
  Title: Response Order

  Read Only: true

  Maximum Length: 80

  Meaning of the response order code.
• SectionId: integer (int64)
  Title: Section Id

  Read Only: true

  Surrogate identifier for the section in a questionnaire.
• 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.

{
    "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":"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.",
            "nullable":true,
            "default":"V",
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "questions":{
            "title":"Questions",
            "type":"array",
            "description":"The questions resource is a child of the questionnaires resource. It provides details of the questions included in a section of the questionnaire.",
            "items":{
                "$ref":"#/components/schemas/questionnaires-sections-questions-item-response"
            }
        },
        "AllowAdditionalQuestionsFlag":{
            "title":"Allow Additional Questions",
            "maxLength":30,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":false
        },
        "ResponseOrderMeaning":{
            "title":"Response Order",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of the response order code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RandomSampleSize":{
            "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,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "QuestionOrderMeaning":{
            "title":"Question Order",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of the question order code.",
            "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"
            }
        },
        "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.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "QuestionOrder":{
            "title":"Question Order Code",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "default":"V",
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SectionId":{
            "title":"Section Id",
            "type":"integer",
            "description":"Surrogate identifier for the section in a questionnaire.",
            "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
        },
        "Mandatory":{
            "title":"Required",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the questionnaire section is mandatory. Valid values are Y and N. The default value is N.",
            "nullable":true,
            "default":"N",
            "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"
    }
}

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

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

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

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

Type: object

Show Source

• AdhocQuestion: string
  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.
• 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.
• AllowAttachmentsFlag: boolean
  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: array 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.
• ConditionalDisplayFlag: boolean
  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.
• ControllingAnswerCode: string
  Title: Controlling Question Code

  Read Only: true

  Maximum Length: 240

  Answer to the controlling question that determines if the question displays or not.
• ControllingAnswerId: integer (int64)
  Title: Controlling Answer Id

  Read Only: true

  Surrogate identifier of the controlling question. Required if the conditional display is set to Y.
• ControllingQuestionCode: string
  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.
• 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 section.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 4000

  Instructions or additional information for the question.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

  Date when the question was last updated in the questionnaire section.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LockQuestionFlag: boolean
  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.
• 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.
• MaximumResponses: integer (int64)
  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.
• MaximumThresholdScore: integer (int64)
  Title: Maximum Calculated Score

  Maximum score limit for the question when the total score is calculated for a response to the question.
• MinimumResponses: integer (int64)
  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.
• MinimumThresholdScore: integer (int64)
  Title: Minimum Calculated Score

  Minimum score limit for the question when the total score is calculated for a response to the question.
• questionAttachments: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• QuestionCode: string
  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.
• QuestionId: integer (int64)
  Title: Question ID

  Surrogate identifier of 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.
• ResponseMaximumLength: string
  Title: Response Maximum Length

  Read Only: true

  Maximum Length: 20

  Maximum allowed length of responses for a text response type.
• ResponseMinimumLength: integer (int64)
  Title: Response Minimum Length

  Read Only: true

  Minimum expected length of responses for a text response type.
• ResponseOrder: string
  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.
• ResponseOrderMeaning: string
  Title: Response Order

  Read Only: true

  Maximum Length: 80

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

  Maximum Length: 30

  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

  Maximum Length: 240

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

  Read Only: true

  Number of answer choices presented to the participant when responding to a question that's enabled for randomization.
• ScoredFlag: boolean
  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.
• SequenceNumber: integer (int64)
  Title: Sequence Number

  Sequence number of the question in a questionnaire template section.
• Status: string
  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.
• VersionNumber: integer (int64)
  Title: Version Number

  Version number of the question in the questionnaire.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the question was added to the questionnaire section.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResponseOrder":{
            "title":"Response Order Code",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ControllingAnswerCode":{
            "title":"Controlling Question Code",
            "maxLength":240,
            "type":"string",
            "description":"Answer to the controlling question that determines if the question displays or not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            }
        },
        "answers":{
            "title":"Answers",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/questionnaires-sections-questions-answers-item-response"
            }
        },
        "ResponseTypeMeaning":{
            "title":"Response Type",
            "maxLength":240,
            "type":"string",
            "description":"Meaning of the response type code.",
            "nullable":false,
            "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":{
                "includeInCompactView":true,
                "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,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ScoredFlag":{
            "title":"Score Question",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the question is used in calculating the score. The default value is N.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "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
        },
        "MinimumThresholdScore":{
            "title":"Minimum Calculated Score",
            "type":"integer",
            "description":"Minimum score limit for the question when the total score is calculated for a response to the question.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "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":{
                "includeInCompactView":true,
                "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-queryable":true
        },
        "ControllingQuestionCode":{
            "title":"Controlling Question Code",
            "maxLength":240,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            }
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"Date when the question was last updated in the questionnaire section.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "description":"Status of the question. Valid values are A for Active, I for Inactive and D for Draft.",
            "nullable":false,
            "readOnly":true,
            "default":"D",
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LockQuestionFlag":{
            "title":"Lock Question",
            "maxLength":8,
            "type":"boolean",
            "description":"Indicates whether you can remove or modify the question in the questionnaire. This is a read-only attribute. The default value is false.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":false
        },
        "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":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "AdhocQuestion":{
            "title":"Casual Question",
            "maxLength":30,
            "type":"string",
            "description":"Setting that indicates if the question added to the questionnaire is an informal or a casual question. This is a read-only attribute.",
            "nullable":false,
            "readOnly":true,
            "default":"N",
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who added the question to the questionnaire section.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AllowAttachmentsFlag":{
            "title":"Allow Attachments",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether an attachment is allowed as a response to the question. The default value is N.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "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
        },
        "ResponseMaximumLength":{
            "title":"Response Maximum Length",
            "maxLength":20,
            "type":"string",
            "description":"Maximum allowed length of responses for a text response type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "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":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ConditionalDisplayFlag":{
            "title":"Conditional Display",
            "maxLength":30,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "VersionNumber":{
            "title":"Version Number",
            "type":"integer",
            "description":"Version number of the question in the questionnaire.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "ResponseType":{
            "title":"Response Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Response type for the question when presented to the participant. Valid values are defined in the questionnaireResponseTypesLOV.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            }
        },
        "MinimumResponses":{
            "title":"Minimum Number of Selections",
            "type":"integer",
            "description":"Minimum number of answer choices that a participant can select when responding to a multiple choice question.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "MaximumResponses":{
            "title":"Maximum Number of Selections",
            "type":"integer",
            "description":"Maximum number of answer choices that a participant can select when responding to a multiple choice question.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "SampleSize":{
            "title":"Sample Size",
            "type":"integer",
            "description":"Number of answer choices presented to the participant when responding to a question that's enabled for randomization.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "ControllingAnswerId":{
            "title":"Controlling Answer Id",
            "type":"integer",
            "description":"Surrogate identifier of the controlling question. Required if the conditional display is set to Y.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "QuestionId":{
            "title":"Question ID",
            "type":"integer",
            "description":"Surrogate identifier of the question.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "questionAttachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/questionnaires-sections-questions-questionAttachments-item-response"
            }
        },
        "MaximumThresholdScore":{
            "title":"Maximum Calculated Score",
            "type":"integer",
            "description":"Maximum score limit for the question when the total score is calculated for a response to the question.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date and time when the question was last updated in the questionnaire section.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResponseMinimumLength":{
            "title":"Response Minimum Length",
            "type":"integer",
            "description":"Minimum expected length of responses for a text response type.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        }
    }
}

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

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

{
    "title":"Answers",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/questionnaires-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 : Attachments

Type: array

Title: Attachments

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

Show Source

• Array of: object questionnaires-sections-questions-questionAttachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/questionnaires-sections-questions-questionAttachments-item-response"
    }
}

Nested Schema : questionnaires-sections-questions-answers-item-response

Type: object

Show Source

• answerAttachments: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• links: array Links
  Title: Links

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 240

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

  Read Only: true

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

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

  Read Only: true

  Maximum Length: 2000

  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,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ResponseCode":{
            "title":"Answer Code",
            "maxLength":240,
            "type":"string",
            "description":"Unique code for the answer choice defined for a question.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Score":{
            "title":"Score",
            "type":"integer",
            "description":"Score for the answer.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "QuestionAnswerId":{
            "title":"Question Answer ID",
            "type":"integer",
            "description":"Surrogate identifier for the answer choice defined for a question.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "answerAttachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/questionnaires-sections-questions-answers-answerAttachments-item-response"
            }
        },
        "ShortDescription":{
            "title":"Short Description",
            "maxLength":2000,
            "type":"string",
            "description":"Answer text for the answer choices of a question.",
            "nullable":true,
            "readOnly":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 questionnaires-sections-questions-answers-answerAttachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/questionnaires-sections-questions-answers-answerAttachments-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 : questionnaires-sections-questions-answers-answerAttachments-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 : questionnaires-sections-questions-questionAttachments-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"
    }
}

Back to Top