Jump to

• Request
• Response

Update a section

patch

/hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{sectionsUniqID}

Request

Path Parameters

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

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.
• 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.
• 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.
• 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":{
        "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
            }
        },
        "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"
            }
        },
        "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-patch-request"
            }
        },
        "SectionName":{
            "title":"Section Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the questionnaire section.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":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
            }
        },
        "IntroText":{
            "title":"Introduction",
            "maxLength":"2000",
            "type":"string",
            "description":"Introduction text for the questionnaire section.",
            "nullable":true,
            "x-queryable":false
        },
        "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 : 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 schema

{
    "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-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• 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.
• 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.
• 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.
• 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.
• 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.
• SequenceNumber: integer (int64)
  Title: Sequence Number

  Sequence number of the question in a questionnaire template section.

{
    "type":"object",
    "properties":{
        "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"
            }
        },
        "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"
            }
        },
        "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-patch-request"
            }
        },
        "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-patch-request"
            }
        },
        "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"
            }
        },
        "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
            }
        },
        "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
            }
        }
    }
}

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 schema

{
    "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-patch-request"
    }
}

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-patch-request

{
    "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-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• answerAttachments: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• Score: integer
  Title: Score

  Score for the answer.

{
    "type":"object",
    "properties":{
        "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-patch-request"
            }
        },
        "Score":{
            "title":"Score",
            "type":"integer",
            "description":"Score for the answer.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

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

Show Source

• Array of: object questionnaires-sections-questions-answers-answerAttachments-item-patch-request

{
    "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-patch-request"
    }
}

Nested Schema : questionnaires-sections-questions-answers-answerAttachments-item-patch-request

Type: object

Show Source

• CategoryName: string
  Title: Category

  Maximum Length: 30

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

  Indicates whether the attachment is shared
• 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.
• 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.

{
    "type":"object",
    "properties":{
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        }
    }
}

Nested Schema : questionnaires-sections-questions-questionAttachments-item-patch-request

Type: object

Show Source

• CategoryName: string
  Title: Category

  Maximum Length: 30

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

  Indicates whether the attachment is shared
• 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.
• 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.

{
    "type":"object",
    "properties":{
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        }
    }
}

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

Links

questionOrdersLOV

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DHRQ_QUESTION_ORDER

The following properties are defined on the LOV link relation:

• Source Attribute: QuestionOrder; Target Attribute: LookupCode
• Display Attribute: LookupCode

questions

Operation: /hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{sectionsUniqID}/child/questions

Parameters:

• questionnairesUniqID: $request.path.questionnairesUniqID
• sectionsUniqID: $request.path.sectionsUniqID

The questions resource is a child of the questionnaires resource. It provides details of the questions included in a section of the questionnaire.

responseOrdersLOV

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DHRQ_QUESTION_ORDER

The following properties are defined on the LOV link relation:

• Source Attribute: ResponseOrder; Target Attribute: LookupCode
• Display Attribute: LookupCode

Back to Top