Jump to

• Request
• Response
• Examples

Update a check-in document

patch

/hcmRestApi/resources/11.13.18.05/checkInDocuments/{checkInDocumentsUniqID}

Request

Path Parameters

• checkInDocumentsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Check-In Documents resource and used to uniquely identify an instance of Check-In Documents. The client should not generate the hash key value. Instead, the client should query on the Check-In Documents collection resource in order to navigate to a specific instance of Check-In Documents 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

• CheckInDate: string (date)
  Title: Date

  Date when the check-in document was created.
• CheckInTemplateId: integer (int64)
  Title: Template

  System-generated primary key for a check-in template.
• CheckInTemplateName: string
  Maximum Length: 400

  Name of a check-in template.
• DocumentName: string
  Title: Document Name

  Maximum Length: 240

  Name of a check-in document.
• ManagerPersonId: integer (int64)
  Title: Manager

  System-generated primary key of the manager in a check-in document.
• ManagerPersonNumber: string
  Title: Person Number

  Maximum Length: 30

  Unique person identifier of the manager in a check-in document.
• questionnaireResponses: array Questionnaire Responses
  Title: Questionnaire Responses

  The questionnaireResponses resource provides the responses by a participant for the questions in a specific version of a questionnaire.

{
    "type":"object",
    "properties":{
        "questionnaireResponses":{
            "title":"Questionnaire Responses",
            "type":"array",
            "description":"The questionnaireResponses resource provides the responses by a participant for the questions in a specific version of a questionnaire.",
            "items":{
                "$ref":"#/components/schemas/checkInDocuments-questionnaireResponses-item-patch-request"
            }
        },
        "CheckInDate":{
            "title":"Date",
            "type":"string",
            "description":"Date when the check-in document was created.",
            "format":"date",
            "nullable":false
        },
        "CheckInTemplateName":{
            "maxLength":"400",
            "type":"string",
            "description":"Name of a check-in template.",
            "nullable":false
        },
        "CheckInTemplateId":{
            "title":"Template",
            "type":"integer",
            "description":"System-generated primary key for a check-in template.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ManagerPersonNumber":{
            "title":"Person Number",
            "maxLength":"30",
            "type":"string",
            "description":"Unique person identifier of the manager in a check-in document.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ManagerPersonId":{
            "title":"Manager",
            "type":"integer",
            "description":"System-generated primary key of the manager in a check-in document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "DocumentName":{
            "title":"Document Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of a check-in document.",
            "nullable":false
        }
    }
}

Nested Schema : Questionnaire Responses

Type: array

Title: Questionnaire Responses

The questionnaireResponses resource provides the responses by a participant for the questions in a specific version of a questionnaire.

Show Source

• Array of: object checkInDocuments-questionnaireResponses-item-patch-request

{
    "title":"Questionnaire Responses",
    "type":"array",
    "description":"The questionnaireResponses resource provides the responses by a participant for the questions in a specific version of a questionnaire.",
    "items":{
        "$ref":"#/components/schemas/checkInDocuments-questionnaireResponses-item-patch-request"
    }
}

Nested Schema : checkInDocuments-questionnaireResponses-item-patch-request

Type: object

Show Source

• questionResponses: array Question Responses
  Title: Question Responses

  The questionResponses resource provides the responses provided by the participant to a specific question in a questionnaire.

{
    "type":"object",
    "properties":{
        "questionResponses":{
            "title":"Question Responses",
            "type":"array",
            "description":"The questionResponses resource provides the responses provided by the participant to a specific question in a questionnaire.",
            "items":{
                "$ref":"#/components/schemas/checkInDocuments-questionnaireResponses-questionResponses-item-patch-request"
            }
        }
    }
}

Nested Schema : Question Responses

Type: array

Title: Question Responses

The questionResponses resource provides the responses provided by the participant to a specific question in a questionnaire.

Show Source

• Array of: object checkInDocuments-questionnaireResponses-questionResponses-item-patch-request

{
    "title":"Question Responses",
    "type":"array",
    "description":"The questionResponses resource provides the responses provided by the participant to a specific question in a questionnaire.",
    "items":{
        "$ref":"#/components/schemas/checkInDocuments-questionnaireResponses-questionResponses-item-patch-request"
    }
}

Nested Schema : checkInDocuments-questionnaireResponses-questionResponses-item-patch-request

Type: object

Show Source

• AnswerCLOB: string (byte)
  Title: Answer Text

  Attachment provided by the participant to respond to the question.
• AnswerList: string
  Title: Answer List

  Maximum Length: 2000

  Concatenated list of answer identifiers (separated by a delimiter) selected by the participant when responding to a multiple choice question.
• QuestionAnswerId: integer (int64)
  Title: Question Answer ID

  Surrogate identifier of the answer that a participant chose when responding to a single choice question.
• responseAttachments: array Attachments
  Title: Attachments

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

{
    "type":"object",
    "properties":{
        "AnswerList":{
            "title":"Answer List",
            "maxLength":"2000",
            "type":"string",
            "description":"Concatenated list of answer identifiers (separated by a delimiter) selected by the participant when responding to a multiple choice question.",
            "nullable":true
        },
        "AnswerCLOB":{
            "title":"Answer Text",
            "type":"string",
            "description":"Attachment provided by the participant to respond to the question.",
            "format":"byte",
            "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/checkInDocuments-questionnaireResponses-questionResponses-responseAttachments-item-patch-request"
            }
        },
        "QuestionAnswerId":{
            "title":"Question Answer ID",
            "type":"integer",
            "description":"Surrogate identifier of the answer that a participant chose when responding to a single choice question.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

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

Show Source

• Array of: object checkInDocuments-questionnaireResponses-questionResponses-responseAttachments-item-patch-request

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

Nested Schema : checkInDocuments-questionnaireResponses-questionResponses-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 : checkInDocuments-item-response

Type: object

Show Source

• AssignmentId: integer (int64)
  System-generated identifier of the job assignment of the worker in a check-in document.
• AssignmentNumber: string
  Title: Assignment Number

  Maximum Length: 30

  Unique assignment identifier of the worker in a check-in document.
• CheckInDate: string (date)
  Title: Date

  Date when the check-in document was created.
• CheckInDocumentId: integer (int64)
  System-generated primary key for a check-in document.
• CheckInTemplateId: integer (int64)
  Title: Template

  System-generated primary key for a check-in template.
• CheckInTemplateName: string
  Maximum Length: 400

  Name of a check-in template.
• DocumentName: string
  Title: Document Name

  Maximum Length: 240

  Name of a check-in document.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ManagerPersonId: integer (int64)
  Title: Manager

  System-generated primary key of the manager in a check-in document.
• ManagerPersonNumber: string
  Title: Person Number

  Maximum Length: 30

  Unique person identifier of the manager in a check-in document.
• PersonId: integer (int64)
  System-generated primary key of the worker in a check-in document.
• PersonNumber: string
  Title: Person Number

  Maximum Length: 30

  Unique person identifier of the worker in a check-in document.
• questionnaireResponses: array Questionnaire Responses
  Title: Questionnaire Responses

  The questionnaireResponses resource provides the responses by a participant for the questions in a specific version of a questionnaire.
• ReviewPeriodId: integer
  System-generated primary key of the review period associated with a check-in document.
• ReviewPeriodName: string
  Maximum Length: 400

  Name of the review period associated with a check-in document.

{
    "type":"object",
    "properties":{
        "PersonNumber":{
            "title":"Person Number",
            "maxLength":"30",
            "type":"string",
            "description":"Unique person identifier of the worker in a check-in document.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CheckInDate":{
            "title":"Date",
            "type":"string",
            "description":"Date when the check-in document was created.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "CheckInTemplateId":{
            "title":"Template",
            "type":"integer",
            "description":"System-generated primary key for a check-in template.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ManagerPersonNumber":{
            "title":"Person Number",
            "maxLength":"30",
            "type":"string",
            "description":"Unique person identifier of the manager in a check-in document.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "questionnaireResponses":{
            "title":"Questionnaire Responses",
            "type":"array",
            "description":"The questionnaireResponses resource provides the responses by a participant for the questions in a specific version of a questionnaire.",
            "items":{
                "$ref":"#/components/schemas/checkInDocuments-questionnaireResponses-item-response"
            }
        },
        "PersonId":{
            "type":"integer",
            "description":"System-generated primary key of the worker in a check-in document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CheckInTemplateName":{
            "maxLength":"400",
            "type":"string",
            "description":"Name of a check-in template.",
            "nullable":false,
            "x-queryable":true
        },
        "ReviewPeriodId":{
            "type":"integer",
            "description":"System-generated primary key of the review period associated with a check-in document.",
            "nullable":true,
            "x-queryable":true
        },
        "AssignmentId":{
            "type":"integer",
            "description":"System-generated identifier of the job assignment of the worker in a check-in document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssignmentNumber":{
            "title":"Assignment Number",
            "maxLength":"30",
            "type":"string",
            "description":"Unique assignment identifier of the worker in a check-in document.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ReviewPeriodName":{
            "maxLength":"400",
            "type":"string",
            "description":"Name of the review period associated with a check-in document.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ManagerPersonId":{
            "title":"Manager",
            "type":"integer",
            "description":"System-generated primary key of the manager in a check-in document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CheckInDocumentId":{
            "type":"integer",
            "description":"System-generated primary key for a check-in document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DocumentName":{
            "title":"Document Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of a check-in document.",
            "nullable":false,
            "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 Responses

Type: array

Title: Questionnaire Responses

The questionnaireResponses resource provides the responses by a participant for the questions in a specific version of a questionnaire.

Show Source

• Array of: object checkInDocuments-questionnaireResponses-item-response

{
    "title":"Questionnaire Responses",
    "type":"array",
    "description":"The questionnaireResponses resource provides the responses by a participant for the questions in a specific version of a questionnaire.",
    "items":{
        "$ref":"#/components/schemas/checkInDocuments-questionnaireResponses-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 : checkInDocuments-questionnaireResponses-item-response

Type: object

Show Source

• AttemptNumber: integer (int64)
  Title: Attempt Number

  Read Only: true

  Attempt number by the participant in responding to a questionnaire.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Name of the user who created the questionnaire response.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the questionnaire response was created.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the questionnaire response was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The link relations associated with the resource instance.
• ParticipantPersonNumber: string
  Title: Person Number

  Read Only: true

  Maximum Length: 30

  Person number of the participant responding to the questionnaire.
• QuestionnaireCode: string
  Title: Questionnaire Code

  Read Only: true

  Maximum Length: 240

  Alphanumeric value which uniquely identifies a questionnaire defined for a subscriber.
• QuestionnaireId: integer (int64)
  Title: Questionnaire ID

  Read Only: true

  Surrogate identifier for the questionnaire that's assigned to the participant.
• QuestionnaireResponseId: integer (int64)
  Title: Questionnaire Response ID

  Surrogate identifier for the questionnaire response.
• QuestionnaireVersionNumber: integer (int64)
  Title: Questionnaire Version Number

  Version number of the questionnaire that the participant responds to.
• questionResponses: array Question Responses
  Title: Question Responses

  The questionResponses resource provides the responses provided by the participant to a specific question in a questionnaire.
• Status: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Status of the questionnaire response. I denotes the response is In progress and isn't submitted yet, while S denotes a submitted response.
• SubmittedDateTime: string (date)
  Title: Submission Date

  Read Only: true

  Date on which the questionnaire response was submitted.

{
    "type":"object",
    "properties":{
        "Status":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Status of the questionnaire response. I denotes the response is In progress and isn't submitted yet, while S denotes a submitted response.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Name of the user who last updated the questionnaire response.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the questionnaire response was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AttemptNumber":{
            "title":"Attempt Number",
            "type":"integer",
            "description":"Attempt number by the participant in responding to a questionnaire.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Name of the user who created the questionnaire response.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantPersonNumber":{
            "title":"Person Number",
            "maxLength":"30",
            "type":"string",
            "description":"Person number of the participant responding to the questionnaire.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SubmittedDateTime":{
            "title":"Submission Date",
            "type":"string",
            "description":"Date on which the questionnaire response was submitted.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "questionResponses":{
            "title":"Question Responses",
            "type":"array",
            "description":"The questionResponses resource provides the responses provided by the participant to a specific question in a questionnaire.",
            "items":{
                "$ref":"#/components/schemas/checkInDocuments-questionnaireResponses-questionResponses-item-response"
            }
        },
        "QuestionnaireVersionNumber":{
            "title":"Questionnaire Version Number",
            "type":"integer",
            "description":"Version number of the questionnaire that the participant responds to.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "QuestionnaireResponseId":{
            "title":"Questionnaire Response ID",
            "type":"integer",
            "description":"Surrogate identifier for the questionnaire response.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "QuestionnaireId":{
            "title":"Questionnaire ID",
            "type":"integer",
            "description":"Surrogate identifier for the questionnaire that's assigned to the participant.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "QuestionnaireCode":{
            "title":"Questionnaire Code",
            "maxLength":"240",
            "type":"string",
            "description":"Alphanumeric value which uniquely identifies a questionnaire defined for a subscriber.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the questionnaire response was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : Question Responses

Type: array

Title: Question Responses

The questionResponses resource provides the responses provided by the participant to a specific question in a questionnaire.

Show Source

• Array of: object checkInDocuments-questionnaireResponses-questionResponses-item-response

{
    "title":"Question Responses",
    "type":"array",
    "description":"The questionResponses resource provides the responses provided by the participant to a specific question in a questionnaire.",
    "items":{
        "$ref":"#/components/schemas/checkInDocuments-questionnaireResponses-questionResponses-item-response"
    }
}

Nested Schema : checkInDocuments-questionnaireResponses-questionResponses-item-response

Type: object

Show Source

• AnswerCLOB: string (byte)
  Title: Answer Text

  Attachment provided by the participant to respond to the question.
• AnswerList: string
  Title: Answer List

  Maximum Length: 2000

  Concatenated list of answer identifiers (separated by a delimiter) selected by the participant when responding to a multiple choice question.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Name of the user who created the question response.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the question response was created.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the question response was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

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

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

  Surrogate identifier of the answer that a participant chose when responding to a single choice question.
• QuestionCode: string
  Title: Question Code

  Read Only: true

  Maximum Length: 240

  Alphanumeric value that uniquely identifies a question defined for a subscriber.
• QuestionnaireQuestionId: integer (int64)
  Title: Questionnaire Question ID

  Surrogate identifier for the question in a questionnaire.
• QuestionResponseId: integer (int64)
  Title: Question Response ID

  Surrogate identifier for the question response.
• responseAttachments: array Attachments
  Title: Attachments

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

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Name of the user who last updated the question response.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "QuestionnaireQuestionId":{
            "title":"Questionnaire Question ID",
            "type":"integer",
            "description":"Surrogate identifier for the question in a questionnaire.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the question response was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "QuestionCode":{
            "title":"Question Code",
            "maxLength":"240",
            "type":"string",
            "description":"Alphanumeric value that uniquely identifies a question defined for a subscriber.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AnswerList":{
            "title":"Answer List",
            "maxLength":"2000",
            "type":"string",
            "description":"Concatenated list of answer identifiers (separated by a delimiter) selected by the participant when responding to a multiple choice question.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Name of the user who created the question response.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AnswerCLOB":{
            "title":"Answer Text",
            "type":"string",
            "description":"Attachment provided by the participant to respond to the question.",
            "format":"byte",
            "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/checkInDocuments-questionnaireResponses-questionResponses-responseAttachments-item-response"
            }
        },
        "QuestionAnswerId":{
            "title":"Question Answer ID",
            "type":"integer",
            "description":"Surrogate identifier of the answer that a participant chose when responding to a single choice question.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "QuestionResponseId":{
            "title":"Question Response ID",
            "type":"integer",
            "description":"Surrogate identifier for the question response.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the question response was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : Attachments

Type: array

Title: Attachments

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

Show Source

• Array of: object checkInDocuments-questionnaireResponses-questionResponses-responseAttachments-item-response

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

Nested Schema : checkInDocuments-questionnaireResponses-questionResponses-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

questionnaireResponses

Operation: /hcmRestApi/resources/11.13.18.05/checkInDocuments/{checkInDocumentsUniqID}/child/questionnaireResponses

Parameters:

• checkInDocumentsUniqID: $request.path.checkInDocumentsUniqID

The questionnaireResponses resource provides the responses by a participant for the questions in a specific version of a questionnaire.

Back to Top

Examples

The following example shows how to update a check-in document by submitting a PATCH request on the REST resource using cURL.

curl -u "<user>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json"  -X PATCH -d <payload> http://<host>:<port>/hcmRestApi/resources/11.13.18.05/checkInDocuments/00100000000EACED00057708000110F084CF513C0000000EACED0005770800000000000000CA0000000EACED0005770800005B0A5B28FC190000000EACED00057708000110F083E844E00000000EACED0005770800000000000000CA0000000EACED0005770800005AF310F6AA9C0000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000000E7F1AB9800780000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B5974190300007870770800004EB9F6DD1400780000000EACED0005770800005AF310F6ABCC0000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000000E7F1AB9800780000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B5974190300007870770800004EB9F6DD1400780000000AACED000577040000000100000001590000000EACED0005770800005AF310F6AAC70000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000000E8CF1D0C00780000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B5974190300007870770800004EB9F6DD140078

Example of Payload

The following is an example of the payload.

"{
  ""DocumentName"": ""Performance Discussion for quarter 1""
}"

Example of Response Header

The following is an example of the response header.

Status: HTTP/1.1 200 OK
Content-Type : application/json

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
    "CheckInDocumentId": 300100183085372,
    "CheckInTemplateId": 300100167943392,
    "CheckInTemplateName": "Check-In Meetings",
    "ReviewPeriodId": 100100037213209,
    "ReviewPeriodName": "Default Review Period - Vision Corporation Enterprise",
    "ManagerPersonId": 100000008153799,
    "ManagerPersonNumber": "8153799",
    "PersonId": 100000008153756,
    "PersonNumber": "8153756",
    "AssignmentId": 100000008154060,
    "AssignmentNumber": "EEEE8153756",
    "DocumentName": "Performance Discussion for quarter 1",
    "CheckInDate": "2018-09-28",
    "links": [...]
}

Back to Top