Jump to

• Request
• Response
• Examples

Update one questionnaire response section record

patch

/fscmRestApi/resources/11.13.18.05/questionnaireResponses/{QuestionnaireRespHeaderId}/child/questionnaireResponseSections/{QuestionnaireRespSectionId}

Request

Path Parameters

• QuestionnaireRespHeaderId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• QuestionnaireRespSectionId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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

• questionnaireResponseDetails: array Questionnaire Response Details
  Title: Questionnaire Response Details

  The Questionnaire Response Details resource manages response details such as response comments and the acceptance note for each question on the questionnaire.
• SectionCompletedFlag: string
  Title: Section Completed

  Maximum Length: 1

  Value indicates section response is completed.

{
    "type":"object",
    "properties":{
        "questionnaireResponseDetails":{
            "title":"Questionnaire Response Details",
            "type":"array",
            "description":"The Questionnaire Response Details resource manages response details such as response comments and the acceptance note for each question on the questionnaire.",
            "items":{
                "$ref":"#/components/schemas/questionnaireResponses-questionnaireResponseSections-questionnaireResponseDetails-item-patch-request"
            }
        },
        "SectionCompletedFlag":{
            "title":"Section Completed",
            "maxLength":"1",
            "type":"string",
            "description":"Value indicates section response is completed.",
            "nullable":true
        }
    }
}

Nested Schema : Questionnaire Response Details

Type: array

Title: Questionnaire Response Details

The Questionnaire Response Details resource manages response details such as response comments and the acceptance note for each question on the questionnaire.

Show Source

• Array of: object schema

{
    "title":"Questionnaire Response Details",
    "type":"array",
    "description":"The Questionnaire Response Details resource manages response details such as response comments and the acceptance note for each question on the questionnaire.",
    "items":{
        "$ref":"#/components/schemas/questionnaireResponses-questionnaireResponseSections-questionnaireResponseDetails-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• questionAttachments: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• QuestionDisplayedFlag: boolean
  Title: Question Displayed

  Maximum Length: 1

  Indicates if the questions were shown to the responders at the time of response submission.
• questionnaireResponseValues: array Questionnaire Response Values
  Title: Questionnaire Response Values

  The Questionnaire Response Values resource stores the response value, which could be a date, text, or number value, to a given question on a questionnaire.
• ResponseComments: string
  Title: Comments

  Maximum Length: 1000

  Comments entered by supplier or internal respondent for response to a question.

{
    "type":"object",
    "properties":{
        "questionAttachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/questionnaireResponses-questionnaireResponseSections-questionnaireResponseDetails-questionAttachments-item-patch-request"
            }
        },
        "ResponseComments":{
            "title":"Comments",
            "maxLength":"1000",
            "type":"string",
            "description":"Comments entered by supplier or internal respondent for response to a question.",
            "nullable":true
        },
        "QuestionDisplayedFlag":{
            "title":"Question Displayed",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the questions were shown to the responders at the time of response submission.",
            "nullable":true
        },
        "questionnaireResponseValues":{
            "title":"Questionnaire Response Values",
            "type":"array",
            "description":"The Questionnaire Response Values resource stores the response value, which could be a date, text, or number value, to a given question on a questionnaire.",
            "items":{
                "$ref":"#/components/schemas/questionnaireResponses-questionnaireResponseSections-questionnaireResponseDetails-questionnaireResponseValues-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 questionnaireResponses-questionnaireResponseSections-questionnaireResponseDetails-questionAttachments-item-patch-request

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/questionnaireResponses-questionnaireResponseSections-questionnaireResponseDetails-questionAttachments-item-patch-request"
    }
}

Nested Schema : Questionnaire Response Values

Type: array

Title: Questionnaire Response Values

The Questionnaire Response Values resource stores the response value, which could be a date, text, or number value, to a given question on a questionnaire.

Show Source

• Array of: object schema

{
    "title":"Questionnaire Response Values",
    "type":"array",
    "description":"The Questionnaire Response Values resource stores the response value, which could be a date, text, or number value, to a given question on a questionnaire.",
    "items":{
        "$ref":"#/components/schemas/questionnaireResponses-questionnaireResponseSections-questionnaireResponseDetails-questionnaireResponseValues-item-patch-request"
    }
}

Nested Schema : questionnaireResponses-questionnaireResponseSections-questionnaireResponseDetails-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"
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• FromUI: string
  Maximum Length: 1

  Value was provided through the user interface.
• IsSelectedFlag: boolean
  Title: Response Selected

  Maximum Length: 1

  Indicates if acceptable response value is selected by the responder or not.
• responseAttachments: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• ResponseValueDate: string (date)
  Title: Response Value Date

  Indicates a response value for a questionnaire question setup with response type as date.
• ResponseValueDatetime: string (date-time)
  Title: Response Value Date Time

  Indicates a response value for a questionnaire question setup with response type as date and time.
• ResponseValueNumber: number
  Title: Response Value Number

  Indicates a response value for a questionnaire question setup with response type as number.
• ResponseValueText: string
  Title: Response Value Text

  Maximum Length: 4000

  Indicates a response value for a questionnaire question setup with response type as text.

{
    "type":"object",
    "properties":{
        "FromUI":{
            "maxLength":"1",
            "type":"string",
            "description":"Value was provided through the user interface.",
            "nullable":true,
            "x-queryable":false
        },
        "responseAttachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/questionnaireResponses-questionnaireResponseSections-questionnaireResponseDetails-questionnaireResponseValues-responseAttachments-item-patch-request"
            }
        },
        "ResponseValueDatetime":{
            "title":"Response Value Date Time",
            "type":"string",
            "description":"Indicates a response value for a questionnaire question setup with response type as date and time.",
            "format":"date-time",
            "nullable":true
        },
        "ResponseValueText":{
            "title":"Response Value Text",
            "maxLength":"4000",
            "type":"string",
            "description":"Indicates a response value for a questionnaire question setup with response type as text.",
            "nullable":true
        },
        "IsSelectedFlag":{
            "title":"Response Selected",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if acceptable response value is selected by the responder or not.",
            "nullable":true
        },
        "ResponseValueDate":{
            "title":"Response Value Date",
            "type":"string",
            "description":"Indicates a response value for a questionnaire question setup with response type as date.",
            "format":"date",
            "nullable":true
        },
        "ResponseValueNumber":{
            "title":"Response Value Number",
            "type":"number",
            "description":"Indicates a response value for a questionnaire question setup with response type as number.",
            "nullable":true
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

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

Show Source

• Array of: object questionnaireResponses-questionnaireResponseSections-questionnaireResponseDetails-questionnaireResponseValues-responseAttachments-item-patch-request

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/questionnaireResponses-questionnaireResponseSections-questionnaireResponseDetails-questionnaireResponseValues-responseAttachments-item-patch-request"
    }
}

Nested Schema : questionnaireResponses-questionnaireResponseSections-questionnaireResponseDetails-questionnaireResponseValues-responseAttachments-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 : questionnaireResponses-questionnaireResponseSections-item-response

Type: object

Show Source

• DisplaySequence: integer (int32)
  Title: Display Sequence

  Read Only: true

  Specifies the order in which the sections should be displayed to the responders on a questionnaire.
• Instructions: string
  Title: Instructions

  Read Only: true

  Maximum Length: 1000

  Indicates the instructions provided to the person responding to questionnaire.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• QuestionnaireRespHeaderId: integer (int64)
  Indicates an Internal system identifier for a questionnaire response.
• questionnaireResponseDetails: array Questionnaire Response Details
  Title: Questionnaire Response Details

  The Questionnaire Response Details resource manages response details such as response comments and the acceptance note for each question on the questionnaire.
• QuestionnaireRespSectionId: integer (int64)
  Indicates value that uniquely identifies a questionnaire response section.
• QuestionnaireSectionId: integer (int64)
  Indicates an Internal system identifier for a questionnaire section.
• QuestionnaireSectionName: string
  Title: Section Name

  Read Only: true

  Maximum Length: 80

  Indicates the name of a section in questionnaire.
• SectionCompletedFlag: string
  Title: Section Completed

  Maximum Length: 1

  Value indicates section response is completed.
• SectionGeneratedFlag: boolean
  Title: Section Generated

  Read Only: true

  Maximum Length: 1

  Indicates if section was generated into the questionnaire response.

{
    "type":"object",
    "properties":{
        "questionnaireResponseDetails":{
            "title":"Questionnaire Response Details",
            "type":"array",
            "description":"The Questionnaire Response Details resource manages response details such as response comments and the acceptance note for each question on the questionnaire.",
            "items":{
                "$ref":"#/components/schemas/questionnaireResponses-questionnaireResponseSections-questionnaireResponseDetails-item-response"
            }
        },
        "QuestionnaireRespHeaderId":{
            "type":"integer",
            "description":"Indicates an Internal system identifier for a questionnaire response.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "QuestionnaireSectionName":{
            "title":"Section Name",
            "maxLength":"80",
            "type":"string",
            "description":"Indicates the name of a section in questionnaire.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"Specifies the order in which the sections should be displayed to the responders on a questionnaire.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Instructions":{
            "title":"Instructions",
            "maxLength":"1000",
            "type":"string",
            "description":"Indicates the instructions provided to the person responding to questionnaire.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SectionGeneratedFlag":{
            "title":"Section Generated",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if section was generated into the questionnaire response.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QuestionnaireSectionId":{
            "type":"integer",
            "description":"Indicates an Internal system identifier for a questionnaire section.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SectionCompletedFlag":{
            "title":"Section Completed",
            "maxLength":"1",
            "type":"string",
            "description":"Value indicates section response is completed.",
            "nullable":true,
            "x-queryable":true
        },
        "QuestionnaireRespSectionId":{
            "type":"integer",
            "description":"Indicates value that uniquely identifies a questionnaire response section.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Questionnaire Response Details

Type: array

Title: Questionnaire Response Details

The Questionnaire Response Details resource manages response details such as response comments and the acceptance note for each question on the questionnaire.

Show Source

• Array of: object questionnaireResponses-questionnaireResponseSections-questionnaireResponseDetails-item-response

{
    "title":"Questionnaire Response Details",
    "type":"array",
    "description":"The Questionnaire Response Details resource manages response details such as response comments and the acceptance note for each question on the questionnaire.",
    "items":{
        "$ref":"#/components/schemas/questionnaireResponses-questionnaireResponseSections-questionnaireResponseDetails-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 : questionnaireResponses-questionnaireResponseSections-questionnaireResponseDetails-item-response

Type: object

Show Source

• AcceptanceNote: string
  Read Only: true

  Maximum Length: 1000

  Note entered by acceptor at the time of acceptance.
• AllowRespCommentFlag: boolean
  Title: Allow comments from responder

  Read Only: true

  Maximum Length: 1

  Indicates whether comments are allowed for the question response.
• AttachmentAllowed: string
  Title: Response Attachments

  Read Only: true

  Maximum Length: 80

  Indicates whether response attachments are required, optional, or not allowed.
• AttachmentAllowedCode: string
  Read Only: true

  Maximum Length: 30

  Code for whether the response attachment is allowed.
• BranchLevel: integer (int32)
  Title: Branch Level

  Read Only: true

  Indicates the level at which question is appearing in the questionnaire.
• Category: string
  Title: Category

  Read Only: true

  Maximum Length: 80

  Indicates the categorization of the supplier attribute that the question is mapped to.
• CategoryCode: string
  Read Only: true

  Maximum Length: 30

  Code for identifying the categorization of the supplier attribute.
• DisplayNumber: string
  Title: Number

  Read Only: true

  Maximum Length: 30

  Indicates the order in which the questions are displayed.
• DisplayPreferredRespFlag: boolean
  Title: Display preferred response

  Read Only: true

  Maximum Length: 1

  Indicates whether there is a preferred response.
• DisplaySequence: integer (int32)
  Read Only: true

  Value that indicates the display sequence of the responses.
• FailedPozValidationFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates that this response failed POZ validation and this response will be ignored
• HasNewerResponseFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates that a newer response is available and this response will be ignored.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MappedToPrereqQuestionFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the question is mapped to a prerequisite question.
• ParentAcceptableResponseId: integer (int64)
  Read Only: true

  Indicates the ID for the acceptable response that the branching question belongs to.
• ParentQuestionnaireQuestId: integer (int64)
  Read Only: true

  Value that uniquely identifies Questionnaire question from the questionnaires table.
• PreferredResponseDate: string (date)
  Title: Preferred Response Date

  Read Only: true

  Value of the preferred response in Date format.
• PreferredResponseDatetime: string (date-time)
  Title: Preferred Response Date and Time

  Read Only: true

  Value of the preferred response in Date and Time format.
• PreferredResponseNumber: number
  Title: Preferred Response Number

  Read Only: true

  Value of the preferred response in Number format.
• PreferredResponseText: string
  Title: Preferred Response Text

  Read Only: true

  Maximum Length: 4000

  Value of the preferred response in Text format.
• questionAttachments: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• QuestionDisplayedFlag: boolean
  Title: Question Displayed

  Maximum Length: 1

  Indicates if the questions were shown to the responders at the time of response submission.
• QuestionHint: string
  Title: Hint

  Read Only: true

  Maximum Length: 1000

  Hint to the question.
• QuestionId: integer (int64)
  Identifier of the questionnaire question.
• QuestionLevel: string
  Title: Question Level

  Read Only: true

  Maximum Length: 80

  Identifier of the questionnaire question.
• QuestionLevelCode: string
  Title: Lookup Code

  Read Only: true

  Maximum Length: 30

  Name of the questionnaire question.
• QuestionnaireQuestionId: integer (int64)
  Value that uniquely identifies Questionnaire question from the questionnaires table.
• QuestionnaireRespHeaderId: integer (int64)
  Value that uniquely Identifies the response to questionnaire.
• QuestionnaireResponseId: integer (int64)
  Value that uniquely identifies a questionnaire question response.
• questionnaireResponseValues: array Questionnaire Response Values
  Title: Questionnaire Response Values

  The Questionnaire Response Values resource stores the response value, which could be a date, text, or number value, to a given question on a questionnaire.
• QuestionnaireRespSectionId: integer (int64)
  Value that uniquely identifies the section of questionnaire.
• QuestionName: string
  Title: Question

  Read Only: true

  Maximum Length: 80

  Name of the questionnaire question.
• QuestionPlainText: string (byte)
  Title: Question Text

  Read Only: true

  Text of the question to be displayed to responders of a questionnaire.
• QuestionText: string (byte)
  Title: Question Text

  Read Only: true

  Text of the question to be displayed to responders of a questionnaire.
• QuestionType: string
  Title: Question Type

  Read Only: true

  Maximum Length: 80

  Specifies whether the question is a multiple choice question with single selection, a multiple choice question with multiple selections, or a text entry box question without predefined acceptable responses.
• QuestionTypeCode: string
  Title: Question Type

  Read Only: true

  Maximum Length: 30

  Code to specify the question type.
• ResponseComments: string
  Title: Comments

  Maximum Length: 1000

  Comments entered by supplier or internal respondent for response to a question.
• ResponseRequiredFlag: boolean
  Title: Response Required

  Read Only: true

  Maximum Length: 1

  Indicates whether the response is required for the question.
• ResponseType: string
  Title: Response Type

  Read Only: true

  Maximum Length: 80

  Indicates the response type for questions of text entry box type, such as text, number or date.
• ResponseTypeCode: string
  Read Only: true

  Maximum Length: 30

  Code to indicate the response type for questions of text entry box type.
• SupplierAttributeCode: string
  Title: Supplier Attribute

  Read Only: true

  Maximum Length: 35

  Code to uniquely identify the supplier attribute that the question is mapped to.
• SupplierAttributeFlag: boolean
  Title: Supplier Attribute

  Read Only: true

  Maximum Length: 1

  Indicates whether the question is mapped to an attribute from the supplier profile.

{
    "type":"object",
    "properties":{
        "CategoryCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code for identifying the categorization of the supplier attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResponseTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code to indicate the response type for questions of text entry box type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplayNumber":{
            "title":"Number",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the order in which the questions are displayed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Category":{
            "title":"Category",
            "maxLength":"80",
            "type":"string",
            "description":"Indicates the categorization of the supplier attribute that the question is mapped to.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplaySequence":{
            "type":"integer",
            "description":"Value that indicates the display sequence of the responses.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "AllowRespCommentFlag":{
            "title":"Allow comments from responder",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether comments are allowed for the question response.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentQuestionnaireQuestId":{
            "type":"integer",
            "description":"Value that uniquely identifies Questionnaire question from the questionnaires table.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResponseComments":{
            "title":"Comments",
            "maxLength":"1000",
            "type":"string",
            "description":"Comments entered by supplier or internal respondent for response to a question.",
            "nullable":true,
            "x-queryable":true
        },
        "FailedPozValidationFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates that this response failed POZ validation and this response will be ignored",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QuestionnaireQuestionId":{
            "type":"integer",
            "description":"Value that uniquely identifies Questionnaire question from the questionnaires table.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AttachmentAllowedCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code for whether the response attachment is allowed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QuestionnaireRespHeaderId":{
            "type":"integer",
            "description":"Value that uniquely Identifies the response to questionnaire.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AttachmentAllowed":{
            "title":"Response Attachments",
            "maxLength":"80",
            "type":"string",
            "description":"Indicates whether response attachments are required, optional, or not allowed.",
            "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"
            }
        },
        "QuestionText":{
            "title":"Question Text",
            "type":"string",
            "description":"Text of the question to be displayed to responders of a questionnaire.",
            "format":"byte",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "BranchLevel":{
            "title":"Branch Level",
            "type":"integer",
            "description":"Indicates the level at which question is appearing in the questionnaire.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "MappedToPrereqQuestionFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the question is mapped to a prerequisite question.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResponseRequiredFlag":{
            "title":"Response Required",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the response is required for the question.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QuestionnaireRespSectionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the section of questionnaire.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "questionnaireResponseValues":{
            "title":"Questionnaire Response Values",
            "type":"array",
            "description":"The Questionnaire Response Values resource stores the response value, which could be a date, text, or number value, to a given question on a questionnaire.",
            "items":{
                "$ref":"#/components/schemas/questionnaireResponses-questionnaireResponseSections-questionnaireResponseDetails-questionnaireResponseValues-item-response"
            }
        },
        "DisplayPreferredRespFlag":{
            "title":"Display preferred response",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether there is a preferred response.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QuestionPlainText":{
            "title":"Question Text",
            "type":"string",
            "description":"Text of the question to be displayed to responders of a questionnaire.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PreferredResponseNumber":{
            "title":"Preferred Response Number",
            "type":"number",
            "description":"Value of the preferred response in Number format.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierAttributeFlag":{
            "title":"Supplier Attribute",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the question is mapped to an attribute from the supplier profile.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "QuestionDisplayedFlag":{
            "title":"Question Displayed",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the questions were shown to the responders at the time of response submission.",
            "nullable":true,
            "x-queryable":true
        },
        "PreferredResponseText":{
            "title":"Preferred Response Text",
            "maxLength":"4000",
            "type":"string",
            "description":"Value of the preferred response in Text format.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QuestionType":{
            "title":"Question Type",
            "maxLength":"80",
            "type":"string",
            "description":"Specifies whether the question is a multiple choice question with single selection, a multiple choice question with multiple selections, or a text entry box question without predefined acceptable responses.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "QuestionLevelCode":{
            "title":"Lookup Code",
            "maxLength":"30",
            "type":"string",
            "description":"Name of the questionnaire question.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierAttributeCode":{
            "title":"Supplier Attribute",
            "maxLength":"35",
            "type":"string",
            "description":"Code to uniquely identify the supplier attribute that the question is mapped to.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QuestionnaireResponseId":{
            "type":"integer",
            "description":"Value that uniquely identifies a questionnaire question response.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "QuestionHint":{
            "title":"Hint",
            "maxLength":"1000",
            "type":"string",
            "description":"Hint to the question.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HasNewerResponseFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates that a newer response is available and this response will be ignored.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResponseType":{
            "title":"Response Type",
            "maxLength":"80",
            "type":"string",
            "description":"Indicates the response type for questions of text entry box type, such as text, number or date.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PreferredResponseDate":{
            "title":"Preferred Response Date",
            "type":"string",
            "description":"Value of the preferred response in Date format.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentAcceptableResponseId":{
            "type":"integer",
            "description":"Indicates the ID for the acceptable response that the branching question belongs to.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "QuestionId":{
            "type":"integer",
            "description":"Identifier of the questionnaire question.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "QuestionName":{
            "title":"Question",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the questionnaire question.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "QuestionTypeCode":{
            "title":"Question Type",
            "maxLength":"30",
            "type":"string",
            "description":"Code to specify the question type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "questionAttachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/questionnaireResponses-questionnaireResponseSections-questionnaireResponseDetails-questionAttachments-item-response"
            }
        },
        "AcceptanceNote":{
            "maxLength":"1000",
            "type":"string",
            "description":"Note entered by acceptor at the time of acceptance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PreferredResponseDatetime":{
            "title":"Preferred Response Date and Time",
            "type":"string",
            "description":"Value of the preferred response in Date and Time format.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QuestionLevel":{
            "title":"Question Level",
            "maxLength":"80",
            "type":"string",
            "description":"Identifier of the questionnaire question.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

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

Show Source

• Array of: object questionnaireResponses-questionnaireResponseSections-questionnaireResponseDetails-questionAttachments-item-response

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

Nested Schema : Questionnaire Response Values

Type: array

Title: Questionnaire Response Values

The Questionnaire Response Values resource stores the response value, which could be a date, text, or number value, to a given question on a questionnaire.

Show Source

• Array of: object questionnaireResponses-questionnaireResponseSections-questionnaireResponseDetails-questionnaireResponseValues-item-response

{
    "title":"Questionnaire Response Values",
    "type":"array",
    "description":"The Questionnaire Response Values resource stores the response value, which could be a date, text, or number value, to a given question on a questionnaire.",
    "items":{
        "$ref":"#/components/schemas/questionnaireResponses-questionnaireResponseSections-questionnaireResponseDetails-questionnaireResponseValues-item-response"
    }
}

Nested Schema : questionnaireResponses-questionnaireResponseSections-questionnaireResponseDetails-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"
    }
}

Nested Schema : questionnaireResponses-questionnaireResponseSections-questionnaireResponseDetails-questionnaireResponseValues-item-response

Type: object

Show Source

• AcceptableResponseId: integer (int64)
  Value that identifies the acceptable response from poq_ques_acc_responses.
• AttachmentAllowed: string
  Title: Response Attachments

  Read Only: true

  Maximum Length: 80

  Indicates whether response attachments are required, optional, or not allowed.
• AttachmentAllowedCode: string
  Read Only: true

  Maximum Length: 30

  Code for whether the response attachment is allowed.
• DisplayNumber: string
  Title: Number

  Read Only: true

  Maximum Length: 5

  Specifies the display number for the acceptable response that will be shown on a questionnaire for this specific question.
• DisplaySequence: integer (int32)
  Read Only: true

  Value that indicates the display sequence of the response values.
• FromUI: string
  Maximum Length: 1

  Value was provided through the user interface.
• HasBranchingFlag: boolean
  Title: Has Branching

  Read Only: true

  Maximum Length: 1

  Indicates whether the response value has branching questions.
• IsSelectedFlag: boolean
  Title: Response Selected

  Maximum Length: 1

  Indicates if acceptable response value is selected by the responder or not.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PreferredResponseFlag: boolean
  Title: Preferred Response

  Read Only: true

  Maximum Length: 1

  Indicates whether there is a preferred response.
• QuestionnaireAccResponseId: integer (int64)
  Value that uniquely identifies the questionnaire's acceptable response.
• QuestionnaireResponseId: integer (int64)
  Value that uniquely Identifies a response to questionnaire question.
• QuestionnaireRespValueId: integer (int64)
  Value that uniquely identifies a response to question.
• responseAttachments: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• ResponseText: string
  Title: Acceptable Response Text

  Read Only: true

  Maximum Length: 1000

  The text of a manually entered response value to a questionnaire question.
• ResponseValueDate: string (date)
  Title: Response Value Date

  Indicates a response value for a questionnaire question setup with response type as date.
• ResponseValueDatetime: string (date-time)
  Title: Response Value Date Time

  Indicates a response value for a questionnaire question setup with response type as date and time.
• ResponseValueNumber: number
  Title: Response Value Number

  Indicates a response value for a questionnaire question setup with response type as number.
• ResponseValueText: string
  Title: Response Value Text

  Maximum Length: 4000

  Indicates a response value for a questionnaire question setup with response type as text.

{
    "type":"object",
    "properties":{
        "DisplayNumber":{
            "title":"Number",
            "maxLength":"5",
            "type":"string",
            "description":"Specifies the display number for the acceptable response that will be shown on a questionnaire for this specific question.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "responseAttachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/questionnaireResponses-questionnaireResponseSections-questionnaireResponseDetails-questionnaireResponseValues-responseAttachments-item-response"
            }
        },
        "AcceptableResponseId":{
            "type":"integer",
            "description":"Value that identifies the acceptable response from poq_ques_acc_responses.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DisplaySequence":{
            "type":"integer",
            "description":"Value that indicates the display sequence of the response values.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "ResponseValueText":{
            "title":"Response Value Text",
            "maxLength":"4000",
            "type":"string",
            "description":"Indicates a response value for a questionnaire question setup with response type as text.",
            "nullable":true,
            "x-queryable":true
        },
        "QuestionnaireRespValueId":{
            "type":"integer",
            "description":"Value that uniquely identifies a response to question.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "QuestionnaireResponseId":{
            "type":"integer",
            "description":"Value that uniquely Identifies a response to questionnaire question.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PreferredResponseFlag":{
            "title":"Preferred Response",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether there is a preferred response.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResponseValueDate":{
            "title":"Response Value Date",
            "type":"string",
            "description":"Indicates a response value for a questionnaire question setup with response type as date.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AttachmentAllowedCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code for whether the response attachment is allowed.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AttachmentAllowed":{
            "title":"Response Attachments",
            "maxLength":"80",
            "type":"string",
            "description":"Indicates whether response attachments are required, optional, or not allowed.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FromUI":{
            "maxLength":"1",
            "type":"string",
            "description":"Value was provided through the user interface.",
            "nullable":true,
            "x-queryable":false
        },
        "HasBranchingFlag":{
            "title":"Has Branching",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the response value has branching questions.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResponseValueDatetime":{
            "title":"Response Value Date Time",
            "type":"string",
            "description":"Indicates a response value for a questionnaire question setup with response type as date and time.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ResponseText":{
            "title":"Acceptable Response Text",
            "maxLength":"1000",
            "type":"string",
            "description":"The text of a manually entered response value to a questionnaire question.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QuestionnaireAccResponseId":{
            "type":"integer",
            "description":"Value that uniquely identifies the questionnaire's acceptable response.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "IsSelectedFlag":{
            "title":"Response Selected",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if acceptable response value is selected by the responder or not.",
            "nullable":true,
            "x-queryable":true
        },
        "ResponseValueNumber":{
            "title":"Response Value Number",
            "type":"number",
            "description":"Indicates a response value for a questionnaire question setup with response type as number.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

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

Show Source

• Array of: object questionnaireResponses-questionnaireResponseSections-questionnaireResponseDetails-questionnaireResponseValues-responseAttachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/questionnaireResponses-questionnaireResponseSections-questionnaireResponseDetails-questionnaireResponseValues-responseAttachments-item-response"
    }
}

Nested Schema : questionnaireResponses-questionnaireResponseSections-questionnaireResponseDetails-questionnaireResponseValues-responseAttachments-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

processSection

Operation: /fscmRestApi/resources/11.13.18.05/questionnaireResponses/{QuestionnaireRespHeaderId}/child/questionnaireResponseSections/{QuestionnaireRespSectionId}/action/processSection

Parameters:

• QuestionnaireRespHeaderId: $request.path.QuestionnaireRespHeaderId
• QuestionnaireRespSectionId: $request.path.QuestionnaireRespSectionId

Process completion status for checklist sections.

questionnaireResponseDetails

Operation: /fscmRestApi/resources/11.13.18.05/questionnaireResponses/{QuestionnaireRespHeaderId}/child/questionnaireResponseSections/{QuestionnaireRespSectionId}/child/questionnaireResponseDetails

Parameters:

• QuestionnaireRespHeaderId: $request.path.QuestionnaireRespHeaderId
• QuestionnaireRespSectionId: $request.path.QuestionnaireRespSectionId

The Questionnaire Response Details resource manages response details such as response comments and the acceptance note for each question on the questionnaire.

Back to Top

Examples

This example describes how to update one questionnaire response section.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/questionnaireResponses/QuestionnaireRespHeaderId/child/questionnaireResponseSections/QuestionnaireRespSectionId"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.

{
    "SectionCompletedFlag": "Y"
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
    "QuestionnaireRespSectionId": 300100584909129,
    "QuestionnaireRespHeaderId": 300100584891833,
    "QuestionnaireSectionId": 300100584891787,
    "QuestionnaireSectionName": "Supplier",
    "DisplaySequence": 2,
    "Instructions": null,
    "SectionGeneratedFlag": false,
    "SectionCompletedFlag": "Y",
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/questionnaireResponses/300100584891833/child/questionnaireResponseSections/300100584909129",
            "name": "questionnaireResponseSections",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/questionnaireResponses/300100584891833/child/questionnaireResponseSections/300100584909129",
            "name": "questionnaireResponseSections",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername/fscmRestApi/resources/version/questionnaireResponses/300100584891833",
            "name": "questionnaireResponses",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/questionnaireResponses/300100584891833/child/questionnaireResponseSections/300100584909129/child/questionnaireResponseDetails",
            "name": "questionnaireResponseDetails",
            "kind": "collection"
        },
        {
            "rel": "action",
            "href": "https://servername/fscmRestApi/resources/version/questionnaireResponses/300100584891833/child/questionnaireResponseSections/300100584909129/action/processSection",
            "name": "processSection",
            "kind": "other"
        }
    ]
}

Back to Top