Jump to

• Request
• Response

Update an answer

patch

/hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/answers/{answersUniqID}

Request

Path Parameters

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

Header Parameters

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AddlQuestionnaireId: integer (int64)
  Title: Additional Questionnaire

  Surrogate identifier of the questionnaire sent to candidates from whom additional information is requested. Used only for the recruiting subscriber.
• AddlQuestionnaireVersionNumber: integer (int64)
  Title: Additional Questionnaire

  Version number of the additional questionnaire sent to the participant. Used only for the recruiting subscriber.
• attachments: array Attachments
  Title: Attachments

  The attachments resource is a child of the questions resource. It includes details of the attachments in a question.
• CorrectFlag: boolean
  Title: Correct Answer Code

  Maximum Length: 30

  Default Value: false

  Indicates whether the answer choice is correct or incorrect for a question.
• LongAnswerText: string
  Title: Short Description

  Maximum Length: 2000

  Answer text presented to the participant as a choice for a question when responding to a questionnaire.
• RatingLevelId: integer (int64)
  Title: Rating Level Id

  Surrogate identifier of the rating level from which the answer choice is created.
• ResponseFeedback: string (byte)
  Title: Response Feedback

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

  Score for the answer choice.
• SequenceNumber: integer (int64)
  Title: Sequence Number

  Sequence in which the answer choice is presented during response by a participant.
• ShortAnswerText: string
  Title: Short Text

  Maximum Length: 240

  Short text of the answer choice.

{
    "type":"object",
    "properties":{
        "ResponseFeedback":{
            "title":"Response Feedback",
            "type":"string",
            "description":"Feedback provided to the participant when the answer choice is chosen.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "Score":{
            "title":"Score",
            "type":"integer",
            "description":"Score for the answer choice.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is a child of the questions resource. It includes details of the attachments in a question.",
            "items":{
                "$ref":"#/components/schemas/questions-answers-attachments-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "LongAnswerText":{
            "title":"Short Description",
            "maxLength":2000,
            "type":"string",
            "description":"Answer text presented to the participant as a choice for a question when responding to a questionnaire.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "AddlQuestionnaireVersionNumber":{
            "title":"Additional Questionnaire",
            "type":"integer",
            "description":"Version number of the additional questionnaire sent to the participant. Used only for the recruiting subscriber.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RatingLevelId":{
            "title":"Rating Level Id",
            "type":"integer",
            "description":"Surrogate identifier of the rating level from which the answer choice is created.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SequenceNumber":{
            "title":"Sequence Number",
            "type":"integer",
            "description":"Sequence in which the answer choice is presented during response by a participant.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "AddlQuestionnaireId":{
            "title":"Additional Questionnaire",
            "type":"integer",
            "description":"Surrogate identifier of the questionnaire sent to candidates from whom additional information is requested. Used only for the recruiting subscriber.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ShortAnswerText":{
            "title":"Short Text",
            "maxLength":240,
            "type":"string",
            "description":"Short text of the answer choice.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            }
        },
        "CorrectFlag":{
            "title":"Correct Answer Code",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the answer choice is correct or incorrect for a question.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "includeInCompactView":true
            }
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is a child of the questions resource. It includes details of the attachments in a question.

Show Source

• Array of: object questions-answers-attachments-item-patch-request

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is a child of the questions resource. It includes details of the attachments in a question.",
    "items":{
        "$ref":"#/components/schemas/questions-answers-attachments-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : questions-answers-attachments-item-patch-request

Type: object

Show Source

• CategoryName: string
  Title: Category

  Maximum Length: 30

  Category name of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Content repository file shared.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  Attachment type supported for the question. Only file attachment is supported.
• Description: string
  Title: Description

  Maximum Length: 255

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

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

  Maximum Length: 1000

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

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

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

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

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

  Expiration date of the attachment.
• FileContents: string (byte)
  Title: File Contents

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

  Maximum Length: 2048

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

  File URL of the attachment.
• PostProcessingAction: string
  Title: PostProcessingAction

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

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

  Content type of the uploaded file.
• UploadedFileLength: integer
  Title: File Size

  Size of the uploaded file.
• UploadedFileName: string
  Title: Uploaded File Name

  Name of the uploaded file.
• UploadedText: string
  Title: Uploaded Text

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

  Maximum Length: 4000

  URI of the attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  URL of a web page type attachment.

{
    "type":"object",
    "properties":{
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Error status message of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"Description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Attachment type supported for the question. Only file attachment is supported.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"Name of the attachment file.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"URI of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Name of the uploaded file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"Surrogate identifier of the document attached to the questionnaire template.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"File URL of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Content repository file shared.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"File contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Content type of the uploaded file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Expiration date of the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Error status code of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string that contains information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"Path of the folder.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text uploaded in the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Category name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Size of the uploaded file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Version number of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        }
    }
}

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 : questions-answers-item-response

Type: object

Show Source

• AddlQuestionnaireId: integer (int64)
  Title: Additional Questionnaire

  Surrogate identifier of the questionnaire sent to candidates from whom additional information is requested. Used only for the recruiting subscriber.
• AddlQuestionnaireVersionNumber: integer (int64)
  Title: Additional Questionnaire

  Version number of the additional questionnaire sent to the participant. Used only for the recruiting subscriber.
• AnswerCode: string
  Title: Answer Code

  Maximum Length: 240

  Alphanumeric value that uniquely identifies the answer choice for a subscriber.
• attachments: array Attachments
  Title: Attachments

  The attachments resource is a child of the questions resource. It includes details of the attachments in a question.
• CorrectFlag: boolean
  Title: Correct Answer Code

  Maximum Length: 30

  Default Value: false

  Indicates whether the answer choice is correct or incorrect for a question.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  Date when the answer choice was created.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

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

  The link relations associated with the resource instance.
• LongAnswerText: string
  Title: Short Description

  Maximum Length: 2000

  Answer text presented to the participant as a choice for a question when responding to a questionnaire.
• QuestionAnswerId: integer (int64)
  Title: Question Answer Id

  Read Only: true

  Surrogate identifier of the answer choice for a question.
• RatingLevelId: integer (int64)
  Title: Rating Level Id

  Surrogate identifier of the rating level from which the answer choice is created.
• RatingLevelName: string
  Title: Rating Level

  Read Only: true

  Maximum Length: 2000

  Rating level from which the answer was created.
• ResponseFeedback: string (byte)
  Title: Response Feedback

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

  Score for the answer choice.
• SequenceNumber: integer (int64)
  Title: Sequence Number

  Sequence in which the answer choice is presented during response by a participant.
• ShortAnswerText: string
  Title: Short Text

  Maximum Length: 240

  Short text of the answer choice.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who last updated the answer choice.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the answer choice was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who created the answer choice.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is a child of the questions resource. It includes details of the attachments in a question.",
            "items":{
                "$ref":"#/components/schemas/questions-answers-attachments-item-response"
            },
            "x-cardinality":"1"
        },
        "LongAnswerText":{
            "title":"Short Description",
            "maxLength":2000,
            "type":"string",
            "description":"Answer text presented to the participant as a choice for a question when responding to a questionnaire.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "RatingLevelName":{
            "title":"Rating Level",
            "maxLength":2000,
            "type":"string",
            "description":"Rating level from which the answer was created.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "RatingLevelId":{
            "title":"Rating Level Id",
            "type":"integer",
            "description":"Surrogate identifier of the rating level from which the answer choice is created.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ShortAnswerText":{
            "title":"Short Text",
            "maxLength":240,
            "type":"string",
            "description":"Short text of the answer choice.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CorrectFlag":{
            "title":"Correct Answer Code",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the answer choice is correct or incorrect for a question.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "AnswerCode":{
            "title":"Answer Code",
            "maxLength":240,
            "type":"string",
            "description":"Alphanumeric value that uniquely identifies the answer choice for a subscriber.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ResponseFeedback":{
            "title":"Response Feedback",
            "type":"string",
            "description":"Feedback provided to the participant when the answer choice is chosen.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "Score":{
            "title":"Score",
            "type":"integer",
            "description":"Score for the answer choice.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "QuestionAnswerId":{
            "title":"Question Answer Id",
            "type":"integer",
            "description":"Surrogate identifier of the answer choice for a question.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "AddlQuestionnaireVersionNumber":{
            "title":"Additional Questionnaire",
            "type":"integer",
            "description":"Version number of the additional questionnaire sent to the participant. Used only for the recruiting subscriber.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SequenceNumber":{
            "title":"Sequence Number",
            "type":"integer",
            "description":"Sequence in which the answer choice is presented during response by a participant.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "AddlQuestionnaireId":{
            "title":"Additional Questionnaire",
            "type":"integer",
            "description":"Surrogate identifier of the questionnaire sent to candidates from whom additional information is requested. Used only for the recruiting subscriber.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date when the answer choice was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is a child of the questions resource. It includes details of the attachments in a question.

Show Source

• Array of: object questions-answers-attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is a child of the questions resource. It includes details of the attachments in a question.",
    "items":{
        "$ref":"#/components/schemas/questions-answers-attachments-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : questions-answers-attachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

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

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

  Maximum Length: 30

  Category name of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Content repository file shared.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

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

  Read Only: true

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

  Read Only: true

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

  Maximum Length: 30

  Default Value: FILE

  Attachment type supported for the question. Only file attachment is supported.
• Description: string
  Title: Description

  Maximum Length: 255

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

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

  Maximum Length: 1000

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

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

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

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

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

  Expiration date of the attachment.
• FileContents: string (byte)
  Title: File Contents

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

  Maximum Length: 2048

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

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

  Read Only: true

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 255

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

  Read Only: true

  User name of the person who last updated the attachment.
• links: array Links
  Title: Links

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

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

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

  Content type of the uploaded file.
• UploadedFileLength: integer
  Title: File Size

  Size of the uploaded file.
• UploadedFileName: string
  Title: Uploaded File Name

  Name of the uploaded file.
• UploadedText: string
  Title: Uploaded Text

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

  Maximum Length: 4000

  URI of the attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

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

  Read Only: true

  Maximum Length: 255

  User name of the person who uploaded the attachment.

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

RatingLevelVO

Operation: /hcmRestApi/resources/11.13.18.05/ratingLevelsLOV

The following properties are defined on the LOV link relation:

• Source Attribute: ShortAnswerText; Target Attribute: RatingLevelCode
• Display Attribute: RatingLevelCode

attachments

Operation: /hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/answers/{answersUniqID}/child/attachments

Parameters:

• answersUniqID: $request.path.answersUniqID
• questionsUniqID: $request.path.questionsUniqID

The attachments resource is a child of the questions resource. It includes details of the attachments in a question.

Back to Top