Jump to

• Request
• Response

Create a health survey

post

/hcmRestApi/resources/11.13.18.05/healthSurveys

Request

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

• EmployeeId: integer (int64)
  Identification value of the employee.
• IncidentDate: string (date-time)
  The date when the incident happened.
• IncidentId: integer (int64)
  An identification value used for the incident.
• IncidentNo(required): string
  Maximum Length: 32

  The number of the incident that's being associated with the main incident.
• IncidentReviewerEmailFlag: boolean
  Maximum Length: 1

  Incident reviewer email flag.
• IncidentSourceCode: string
  Maximum Length: 30

  Label to indicate the origin of the incident record. For example an incident generated using an API or an incident entered using the self-service kiosk pages.
• IncidentSummary(required): string
  Maximum Length: 1000

  Audit detail for incident summary.
• IncidentTypeCode: string
  Maximum Length: 30

  Label to indicate the type of incident recorded. For example a health and safety incident or a data security incident.
• LocationId: integer (int64)
  An identification value used for the location.
• ObjectVersionNumber: integer (int32)
  Object version number for the survey.
• OffsiteLocTypeCode: string
  Maximum Length: 30

  A label to describe the category of the offsite location.
• QuestionnaireId: integer
  An identification value used for the questionnaire owner
• QuestionnaireResponses: array Incident ID
  Title: Incident ID

  Questions and responses to use in a questionnaire in a health survey incident.
• ReporterTypeCode: string
  Maximum Length: 30

  Default Value: ORA_EMPLOYEE

  Value that identifies whether the person who's reporting the incident is an employee or a nonemployee.
• ReptrAreaCode: string
  Maximum Length: 30

  Label for the phone area code of the incident reporter.
• ReptrCountry: string
  Maximum Length: 100

  The name of the country where the incident occurred.
• ReptrCountryCodeNum: string
  Maximum Length: 30

  The phone country code for the incident reporter.
• ReptrEmail: string
  Maximum Length: 250

  The incident reporter email.
• ReptrName: string
  Maximum Length: 200

  The incident reporter name.
• ReptrNonempTypeCode: string
  Maximum Length: 30

  A label to describe if the incident reporter is an employee or nonemployee.
• ReptrPhoneNo: string
  Maximum Length: 18

  The incident reporter phone number.
• ReptrSpecificLocation(required): string
  Maximum Length: 255

  The incident reporter specific location.
• TargetCompletionDate(required): string (date-time)
  The date that the investigation is targeted for completion.

{
    "required":[
        "IncidentNo",
        "IncidentSummary",
        "ReptrSpecificLocation",
        "TargetCompletionDate"
    ],
    "type":"object",
    "properties":{
        "ReptrCountry":{
            "maxLength":"100",
            "type":"string",
            "description":"The name of the country where the incident occurred.",
            "nullable":true
        },
        "ReptrCountryCodeNum":{
            "maxLength":"30",
            "type":"string",
            "description":"The phone country code for the incident reporter.",
            "nullable":true
        },
        "ReptrEmail":{
            "maxLength":"250",
            "type":"string",
            "description":"The incident reporter email.",
            "nullable":true
        },
        "IncidentReviewerEmailFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Incident reviewer email flag.",
            "nullable":true
        },
        "IncidentDate":{
            "type":"string",
            "description":"The date when the incident happened.",
            "format":"date-time",
            "nullable":false
        },
        "LocationId":{
            "type":"integer",
            "description":"An identification value used for the location.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "IncidentSourceCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Label to indicate the origin of the incident record. For example an incident generated using an API or an incident entered using the self-service kiosk pages.",
            "nullable":true
        },
        "QuestionnaireResponses":{
            "title":"Incident ID",
            "type":"array",
            "description":"Questions and responses to use in a questionnaire in a health survey incident.",
            "items":{
                "$ref":"#/components/schemas/healthSurveys-QuestionnaireResponses-item-post-request"
            }
        },
        "IncidentTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Label to indicate the type of incident recorded. For example a health and safety incident or a data security incident.",
            "nullable":true
        },
        "IncidentId":{
            "type":"integer",
            "description":"An identification value used for the incident.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "IncidentNo":{
            "maxLength":"32",
            "type":"string",
            "description":"The number of the incident that's being associated with the main incident.",
            "nullable":false
        },
        "IncidentSummary":{
            "maxLength":"1000",
            "type":"string",
            "description":"Audit detail for incident summary.",
            "nullable":false
        },
        "ReptrPhoneNo":{
            "maxLength":"18",
            "type":"string",
            "description":"The incident reporter phone number.",
            "nullable":true
        },
        "TargetCompletionDate":{
            "type":"string",
            "description":"The date that the investigation is targeted for completion.",
            "format":"date-time",
            "nullable":false
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Object version number for the survey.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "ReptrAreaCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Label for the phone area code of the incident reporter.",
            "nullable":true
        },
        "ReptrSpecificLocation":{
            "maxLength":"255",
            "type":"string",
            "description":"The incident reporter specific location.",
            "nullable":false
        },
        "ReptrNonempTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"A label to describe if the incident reporter is an employee or nonemployee.",
            "nullable":true
        },
        "OffsiteLocTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"A label to describe the category of the offsite location.",
            "nullable":true
        },
        "QuestionnaireId":{
            "type":"integer",
            "description":"An identification value used for the questionnaire owner",
            "nullable":true
        },
        "ReporterTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that identifies whether the person who's reporting the incident is an employee or a nonemployee.",
            "nullable":true,
            "default":"ORA_EMPLOYEE"
        },
        "EmployeeId":{
            "type":"integer",
            "description":"Identification value of the employee.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ReptrName":{
            "maxLength":"200",
            "type":"string",
            "description":"The incident reporter name.",
            "nullable":true
        }
    }
}

Nested Schema : Incident ID

Type: array

Title: Incident ID

Questions and responses to use in a questionnaire in a health survey incident.

Show Source

• Array of: object healthSurveys-QuestionnaireResponses-item-post-request

{
    "title":"Incident ID",
    "type":"array",
    "description":"Questions and responses to use in a questionnaire in a health survey incident.",
    "items":{
        "$ref":"#/components/schemas/healthSurveys-QuestionnaireResponses-item-post-request"
    }
}

Nested Schema : healthSurveys-QuestionnaireResponses-item-post-request

Type: object

Show Source

• AttachmentEntityName: string
  Maximum Length: 255

  Default Value: HRQ_QSTN_RESPONSE

  Name of the attachment entity.
• Attachments: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• BusinessGroupId: string
  Maximum Length: 255

  An identification value used for business group.
• IncidentId: string
  An identification value used for the incident.
• QstnResponseId: string
  An identification value used for the questionnaire response.
• QuestionId: integer
  An identification value used for the question.
• QuestionResponse: string
  Question response value.

{
    "type":"object",
    "properties":{
        "QuestionId":{
            "type":"integer",
            "description":"An identification value used for the question.",
            "nullable":true
        },
        "QstnResponseId":{
            "type":"string",
            "description":"An identification value used for the questionnaire response.",
            "nullable":true
        },
        "BusinessGroupId":{
            "maxLength":"255",
            "type":"string",
            "description":"An identification value used for business group.",
            "nullable":true
        },
        "Attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/healthSurveys-QuestionnaireResponses-Attachments-item-post-request"
            }
        },
        "IncidentId":{
            "type":"string",
            "description":"An identification value used for the incident.",
            "nullable":true
        },
        "AttachmentEntityName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the attachment entity.",
            "nullable":true,
            "default":"HRQ_QSTN_RESPONSE"
        },
        "QuestionResponse":{
            "type":"string",
            "description":"Question response value.",
            "nullable":true
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

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

Show Source

• Array of: object schema

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/healthSurveys-QuestionnaireResponses-Attachments-item-post-request"
    }
}

Nested Schema : schema

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
• 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":{
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        }
    }
}

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 : healthSurveys-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user ID of the person who created the record.
• CreationDate: string (date-time)
  Read Only: true

  Creation date of the health survey record.
• EmployeeId: integer (int64)
  Identification value of the employee.
• IncidentDate: string (date-time)
  The date when the incident happened.
• IncidentId: integer (int64)
  An identification value used for the incident.
• IncidentNo: string
  Maximum Length: 32

  The number of the incident that's being associated with the main incident.
• IncidentReviewerEmailFlag: boolean
  Maximum Length: 1

  Incident reviewer email flag.
• IncidentSourceCode: string
  Maximum Length: 30

  Label to indicate the origin of the incident record. For example an incident generated using an API or an incident entered using the self-service kiosk pages.
• IncidentSummary: string
  Maximum Length: 1000

  Audit detail for incident summary.
• IncidentTypeCode: string
  Maximum Length: 30

  Label to indicate the type of incident recorded. For example a health and safety incident or a data security incident.
• LastUpdateDate: string (date-time)
  Read Only: true

  The last date that the record was updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user ID of the person who last updated the record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Login of last updated user.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationId: integer (int64)
  An identification value used for the location.
• ObjectVersionNumber: integer (int32)
  Object version number for the survey.
• OffsiteLocTypeCode: string
  Maximum Length: 30

  A label to describe the category of the offsite location.
• QuestionnaireId: integer
  An identification value used for the questionnaire owner
• QuestionnaireResponses: array Incident ID
  Title: Incident ID

  Questions and responses to use in a questionnaire in a health survey incident.
• ReporterTypeCode: string
  Maximum Length: 30

  Default Value: ORA_EMPLOYEE

  Value that identifies whether the person who's reporting the incident is an employee or a nonemployee.
• ReptrAreaCode: string
  Maximum Length: 30

  Label for the phone area code of the incident reporter.
• ReptrCountry: string
  Maximum Length: 100

  The name of the country where the incident occurred.
• ReptrCountryCodeNum: string
  Maximum Length: 30

  The phone country code for the incident reporter.
• ReptrEmail: string
  Maximum Length: 250

  The incident reporter email.
• ReptrName: string
  Maximum Length: 200

  The incident reporter name.
• ReptrNonempTypeCode: string
  Maximum Length: 30

  A label to describe if the incident reporter is an employee or nonemployee.
• ReptrPhoneNo: string
  Maximum Length: 18

  The incident reporter phone number.
• ReptrSpecificLocation: string
  Maximum Length: 255

  The incident reporter specific location.
• TargetCompletionDate: string (date-time)
  The date that the investigation is targeted for completion.

{
    "type":"object",
    "properties":{
        "ReptrCountry":{
            "maxLength":"100",
            "type":"string",
            "description":"The name of the country where the incident occurred.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Creation date of the health survey record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReptrEmail":{
            "maxLength":"250",
            "type":"string",
            "description":"The incident reporter email.",
            "nullable":true,
            "x-queryable":true
        },
        "IncidentTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Label to indicate the type of incident recorded. For example a health and safety incident or a data security incident.",
            "nullable":true,
            "x-queryable":true
        },
        "IncidentNo":{
            "maxLength":"32",
            "type":"string",
            "description":"The number of the incident that's being associated with the main incident.",
            "nullable":false,
            "x-queryable":true
        },
        "ReptrPhoneNo":{
            "maxLength":"18",
            "type":"string",
            "description":"The incident reporter phone number.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Object version number for the survey.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "ReptrAreaCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Label for the phone area code of the incident reporter.",
            "nullable":true,
            "x-queryable":true
        },
        "QuestionnaireId":{
            "type":"integer",
            "description":"An identification value used for the questionnaire owner",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EmployeeId":{
            "type":"integer",
            "description":"Identification value of the employee.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user ID of the person who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReptrCountryCodeNum":{
            "maxLength":"30",
            "type":"string",
            "description":"The phone country code for the incident reporter.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user ID of the person who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IncidentReviewerEmailFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Incident reviewer email flag.",
            "nullable":true,
            "x-queryable":true
        },
        "IncidentDate":{
            "type":"string",
            "description":"The date when the incident happened.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "LocationId":{
            "type":"integer",
            "description":"An identification value used for the location.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "IncidentSourceCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Label to indicate the origin of the incident record. For example an incident generated using an API or an incident entered using the self-service kiosk pages.",
            "nullable":true,
            "x-queryable":true
        },
        "QuestionnaireResponses":{
            "title":"Incident ID",
            "type":"array",
            "description":"Questions and responses to use in a questionnaire in a health survey incident.",
            "items":{
                "$ref":"#/components/schemas/healthSurveys-QuestionnaireResponses-item-response"
            }
        },
        "IncidentId":{
            "type":"integer",
            "description":"An identification value used for the incident.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "IncidentSummary":{
            "maxLength":"1000",
            "type":"string",
            "description":"Audit detail for incident summary.",
            "nullable":false,
            "x-queryable":true
        },
        "TargetCompletionDate":{
            "type":"string",
            "description":"The date that the investigation is targeted for completion.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "ReptrSpecificLocation":{
            "maxLength":"255",
            "type":"string",
            "description":"The incident reporter specific location.",
            "nullable":false,
            "x-queryable":true
        },
        "ReptrNonempTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"A label to describe if the incident reporter is an employee or nonemployee.",
            "nullable":true,
            "x-queryable":true
        },
        "OffsiteLocTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"A label to describe the category of the offsite location.",
            "nullable":true,
            "x-queryable":true
        },
        "ReporterTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that identifies whether the person who's reporting the incident is an employee or a nonemployee.",
            "nullable":true,
            "default":"ORA_EMPLOYEE",
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"Login of last updated user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The last date that the record was updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReptrName":{
            "maxLength":"200",
            "type":"string",
            "description":"The incident reporter name.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : Incident ID

Type: array

Title: Incident ID

Questions and responses to use in a questionnaire in a health survey incident.

Show Source

• Array of: object healthSurveys-QuestionnaireResponses-item-response

{
    "title":"Incident ID",
    "type":"array",
    "description":"Questions and responses to use in a questionnaire in a health survey incident.",
    "items":{
        "$ref":"#/components/schemas/healthSurveys-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 : healthSurveys-QuestionnaireResponses-item-response

Type: object

Show Source

• AttachmentEntityName: string
  Maximum Length: 255

  Default Value: HRQ_QSTN_RESPONSE

  Name of the attachment entity.
• Attachments: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• BusinessGroupId: string
  Maximum Length: 255

  An identification value used for business group.
• IncidentId: string
  An identification value used for the incident.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• QstnResponseId: string
  An identification value used for the questionnaire response.
• QuestionId: integer
  An identification value used for the question.
• QuestionResponse: string
  Question response value.

{
    "type":"object",
    "properties":{
        "QuestionId":{
            "type":"integer",
            "description":"An identification value used for the question.",
            "nullable":true,
            "x-queryable":true
        },
        "QstnResponseId":{
            "type":"string",
            "description":"An identification value used for the questionnaire response.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BusinessGroupId":{
            "maxLength":"255",
            "type":"string",
            "description":"An identification value used for business group.",
            "nullable":true,
            "x-queryable":true
        },
        "Attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/healthSurveys-QuestionnaireResponses-Attachments-item-response"
            }
        },
        "IncidentId":{
            "type":"string",
            "description":"An identification value used for the incident.",
            "nullable":true,
            "x-queryable":true
        },
        "AttachmentEntityName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the attachment entity.",
            "nullable":true,
            "default":"HRQ_QSTN_RESPONSE",
            "x-queryable":true
        },
        "QuestionResponse":{
            "type":"string",
            "description":"Question response value.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

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

Show Source

• Array of: object healthSurveys-QuestionnaireResponses-Attachments-item-response

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : healthSurveys-QuestionnaireResponses-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

  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/healthSurveys/{IncidentId}/child/QuestionnaireResponses

Parameters:

• IncidentId: $request.path.IncidentId

Questions and responses to use in a questionnaire in a health survey incident.

Back to Top