Jump to

• Request
• Response

Create a journey task

patch

/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}

Request

Path Parameters

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

Header Parameters

• Effective-Of:
  This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
• 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

• ActionAddToCalendarLabel: string
  Maximum Length: 120

  Setting that enables to change the label of the add to calendar action.
• ActionCompleteLabel: string
  Maximum Length: 120

  Setting that enables to change the label of the complete action.
• ActionRejectLabel: string
  Maximum Length: 120

  Setting that enables to change the label of the not applicable action.
• ActionSaveLabel: string
  Maximum Length: 120

  Setting that enables to change the label of the save as draft action.
• ActionURL: string
  Title: URL

  Maximum Length: 1000

  URL associated with the task. This task URL is returned as entered during setup.
• ActivityAction1Label: string
  Maximum Length: 120

  Setting that enables to change the label of action 1.
• ActivityAction2Label: string
  Maximum Length: 120

  Setting that enables to change the label of action 2.
• ActivityAction3Label: string
  Maximum Length: 120

  Setting that enables to change the label of action 3.
• ActivityAction4Label: string
  Maximum Length: 120

  Setting that enables to change the label of action 4.
• ActivityAction5Label: string
  Maximum Length: 120

  Setting that enables to change the label of action 5.
• ActualEndDate: string (date)
  Title: Actual End Date

  Date on which the task was completed.
• ActualStartDate: string (date)
  Title: Actual Start Date

  Date on which the task was opened.
• AllowAttachmentFlag: boolean
  Title: Allow Attachments

  Indicates whether attachments are enabled for a task. Valid values are Yes or No. The default value is No.
• AllowCommentFlag: boolean
  Title: Allow Comments

  Indicates whether comments are enabled for a task. Valid values are Yes or No. The default value is No.
• AllowNotesContentFlag: boolean
  Indicates whether rich content can be added for notes. Valid values are Yes or No. The default is Yes.
• AttachmentDocumentTypeId: integer (int64)
  Title: Document Type for Attachments

  Attachments to add to document records for the given document type.
• attachments: array Candidate Attachments
  Title: Candidate Attachments

  The addresses resource is the child of the recruitingUICandidates resource and provides information about the addresses of a candidate.
• Comments: string
  Title: Comments

  Maximum Length: 4000

  Comments for the task.
• CompletedFeedFlag: boolean
  Indicates whether the atom feed is enabled when a journey task is completed.
• ContentProviderCode: string
  Maximum Length: 240

  Code of the user-defined content task.
• DeletedFeedFlag: boolean
  Indicates whether the atom feed is enabled when a journey task is deleted.
• Description: string
  Title: Description

  Maximum Length: 4000

  Description of the task.
• documents: array Candidate Attachments
  Title: Candidate Attachments

  The addresses resource is the child of the recruitingUICandidates resource and provides information about the addresses of a candidate.
• DocumentTypeId: integer (int64)
  Title: Document Type Identifier

  Identifier of the document type.
• ExpiryDuration: integer (int32)
  Title: Expiry Days

  Duration after which the task expires.
• ExpiryRelativeTo: string
  Maximum Length: 30

  Criteria based on which the task expires.
• FeedFlag: boolean
  Indicates whether the atom feed is enabled for a journey task.
• InitiatedFeedFlag: boolean
  Indicates whether the atom feed is enabled when a journey task is initiated.
• LearnCommunityId: integer (int64)
  Identifier of the learning community.
• LearnEnrollmentId: integer (int64)
  Identifier of the learning enrollment.
• LearnEnrollmentType: string
  Maximum Length: 80

  Type of learning enrollment.
• learningItems: array Learning Content Items List of Values
  Title: Learning Content Items List of Values

  The learningContentItemsLOV resource provides a list of learning content items such as SCORM, HACP, PDF, video, assessment, and web link.
• Name: string
  Title: Name

  Maximum Length: 240

  Name of the task.
• Notes: string (byte)
  Title: Notes

  Notes for a task. The notes text is stored as a CLOB object. To use in the payload, the text should be converted to a base64 encoded string using either a conversion tool or a prerequisite script.
• notifications: array Notifications
  Title: Notifications

  The notifications resource is a child of the tasks resource. It includes notification settings for the task performer and owner.
• properties: array Properties
  Title: Properties

  The properties resource is a child of the tasks resource. It includes display property settings for a task.
• questionnaireResponses: array Questionnaire Responses
  Title: Questionnaire Responses

  The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.
• ReassignedFeedFlag: boolean
  Indicates whether the atom feed is enabled when a journey task is reassigned.
• ReminderDuration: string
  Title: Reminder Duration

  Maximum Length: 30

  Duration of the task reminder, that's number of days between reminders.
• ReminderRecurrence: string
  Title: Reminder Recurrence

  Maximum Length: 30

  Reminder for task recurrence, such as the number of times the reminders need to be sent.
• ReminderRelativeTo: string
  Title: Enable Reminder

  Maximum Length: 30

  Task reminder that's relative either to due date or start date.
• RequiredFlag: boolean
  Title: Required

  Maximum Length: 30

  Indicates whether the task is mandatory or optional. Valid values are Yes and No. The default value is No.
• SaveAttachmentsToDORFor: string
  Task attachment to save to document records.
• Sequence: integer (int32)
  Title: Sequence

  Task display ordering sequence, if specified.
• SignAddress: string
  Title: IP Address of Signature

  Maximum Length: 120

  Internet protocol address where the electronic signature was provided.
• SignatureImageData: string (byte)
  Signature of the user in a native electronic signature task.
• SignerAuthentication: string
  Authentication password of the signer in an electronic signature task.
• SignerEmail: string
  Title: Email of Signer

  Maximum Length: 400

  Email address of the signer for an electronic signature task.
• SignerName: string
  Title: Name of Signer

  Maximum Length: 120

  Name of the signer for an electronic signature task.
• Status: string
  Title: Status Code

  Maximum Length: 60

  Status code of the task.
• TargetEndDate: string (date)
  Title: Target End Date

  Due date of the task.
• TargetStartDate: string (date)
  Title: Target Start Date

  Expected initiation date of the task.
• TaskCompletionEnabledFlag: boolean
  Indicates if the task can be completed.
• tasksDFF: array tasksDFF
• Type: string
  Title: Type Code

  Maximum Length: 80

  Code for the task action type.

{
    "type":"object",
    "properties":{
        "SignatureImageData":{
            "type":"string",
            "description":"Signature of the user in a native electronic signature task.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ContentProviderCode":{
            "maxLength":"240",
            "type":"string",
            "description":"Code of the user-defined content task.",
            "nullable":true,
            "x-queryable":false
        },
        "documents":{
            "title":"Candidate Attachments",
            "type":"array",
            "description":"The addresses resource is the child of the recruitingUICandidates resource and provides information about the addresses of a candidate.",
            "items":{
                "$ref":"#/components/schemas/workerJourneyTasks-documents-item-patch-request"
            }
        },
        "ActionSaveLabel":{
            "maxLength":"120",
            "type":"string",
            "description":"Setting that enables to change the label of the save as draft action.",
            "nullable":true,
            "x-queryable":false
        },
        "SignAddress":{
            "title":"IP Address of Signature",
            "maxLength":"120",
            "type":"string",
            "description":"Internet protocol address where the electronic signature was provided.",
            "nullable":true,
            "x-queryable":false
        },
        "ActualStartDate":{
            "title":"Actual Start Date",
            "type":"string",
            "description":"Date on which the task was opened.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "ActionRejectLabel":{
            "maxLength":"120",
            "type":"string",
            "description":"Setting that enables to change the label of the not applicable action.",
            "nullable":true,
            "x-queryable":false
        },
        "Name":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the task.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ActivityAction1Label":{
            "maxLength":"120",
            "type":"string",
            "description":"Setting that enables to change the label of action 1.",
            "nullable":true,
            "x-queryable":false
        },
        "AllowAttachmentFlag":{
            "title":"Allow Attachments",
            "type":"boolean",
            "description":"Indicates whether attachments are enabled for a task. Valid values are Yes or No. The default value is No.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LearnCommunityId":{
            "type":"integer",
            "description":"Identifier of the learning community.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "LearnEnrollmentId":{
            "type":"integer",
            "description":"Identifier of the learning enrollment.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "DeletedFeedFlag":{
            "type":"boolean",
            "description":"Indicates whether the atom feed is enabled when a journey task is deleted.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "SignerEmail":{
            "title":"Email of Signer",
            "maxLength":"400",
            "type":"string",
            "description":"Email address of the signer for an electronic signature task.",
            "nullable":true,
            "x-queryable":false
        },
        "Status":{
            "title":"Status Code",
            "maxLength":"60",
            "type":"string",
            "description":"Status code of the task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            }
        },
        "ReassignedFeedFlag":{
            "type":"boolean",
            "description":"Indicates whether the atom feed is enabled when a journey task is reassigned.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "TargetStartDate":{
            "title":"Target Start Date",
            "type":"string",
            "description":"Expected initiation date of the task.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "learningItems":{
            "title":"Learning Content Items List of Values",
            "type":"array",
            "description":"The learningContentItemsLOV resource provides a list of learning content items such as SCORM, HACP, PDF, video, assessment, and web link.",
            "items":{
                "$ref":"#/components/schemas/workerJourneyTasks-learningItems-item-patch-request"
            }
        },
        "TargetEndDate":{
            "title":"Target End Date",
            "type":"string",
            "description":"Due date of the task.",
            "format":"date",
            "nullable":true
        },
        "FeedFlag":{
            "type":"boolean",
            "description":"Indicates whether the atom feed is enabled for a journey task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "Sequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"Task display ordering sequence, if specified.",
            "format":"int32",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "tasksDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/workerJourneyTasks-tasksDFF-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "questionnaireResponses":{
            "title":"Questionnaire Responses",
            "type":"array",
            "description":"The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.",
            "items":{
                "$ref":"#/components/schemas/workerJourneyTasks-questionnaireResponses-item-patch-request"
            }
        },
        "AllowNotesContentFlag":{
            "type":"boolean",
            "description":"Indicates whether rich content can be added for notes. Valid values are Yes or No. The default is Yes.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "notifications":{
            "title":"Notifications",
            "type":"array",
            "description":"The notifications resource is a child of the tasks resource. It includes notification settings for the task performer and owner.",
            "items":{
                "$ref":"#/components/schemas/workerJourneyTasks-notifications-item-patch-request"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"4000",
            "type":"string",
            "description":"Description of the task.",
            "nullable":true,
            "x-queryable":false
        },
        "SaveAttachmentsToDORFor":{
            "type":"string",
            "description":"Task attachment to save to document records.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "attachments":{
            "title":"Candidate Attachments",
            "type":"array",
            "description":"The addresses resource is the child of the recruitingUICandidates resource and provides information about the addresses of a candidate.",
            "items":{
                "$ref":"#/components/schemas/workerJourneyTasks-attachments-item-patch-request"
            }
        },
        "ActivityAction3Label":{
            "maxLength":"120",
            "type":"string",
            "description":"Setting that enables to change the label of action 3.",
            "nullable":true,
            "x-queryable":false
        },
        "LearnEnrollmentType":{
            "maxLength":"80",
            "type":"string",
            "description":"Type of learning enrollment.",
            "nullable":true,
            "x-queryable":false
        },
        "CompletedFeedFlag":{
            "type":"boolean",
            "description":"Indicates whether the atom feed is enabled when a journey task is completed.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ExpiryRelativeTo":{
            "maxLength":"30",
            "type":"string",
            "description":"Criteria based on which the task expires.",
            "nullable":true,
            "x-queryable":false
        },
        "TaskCompletionEnabledFlag":{
            "type":"boolean",
            "description":"Indicates if the task can be completed.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "AllowCommentFlag":{
            "title":"Allow Comments",
            "type":"boolean",
            "description":"Indicates whether comments are enabled for a task. Valid values are Yes or No. The default value is No.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ActionAddToCalendarLabel":{
            "maxLength":"120",
            "type":"string",
            "description":"Setting that enables to change the label of the add to calendar action.",
            "nullable":true,
            "x-queryable":false
        },
        "ActivityAction4Label":{
            "maxLength":"120",
            "type":"string",
            "description":"Setting that enables to change the label of action 4.",
            "nullable":true,
            "x-queryable":false
        },
        "SignerAuthentication":{
            "type":"string",
            "description":"Authentication password of the signer in an electronic signature task.",
            "nullable":true
        },
        "SignerName":{
            "title":"Name of Signer",
            "maxLength":"120",
            "type":"string",
            "description":"Name of the signer for an electronic signature task.",
            "nullable":true,
            "x-queryable":false
        },
        "Notes":{
            "title":"Notes",
            "type":"string",
            "description":"Notes for a task. The notes text is stored as a CLOB object. To use in the payload, the text should be converted to a base64 encoded string using either a conversion tool or a prerequisite script.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ActualEndDate":{
            "title":"Actual End Date",
            "type":"string",
            "description":"Date on which the task was completed.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "ExpiryDuration":{
            "title":"Expiry Days",
            "type":"integer",
            "description":"Duration after which the task expires.",
            "format":"int32",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"5"
            }
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"4000",
            "type":"string",
            "description":"Comments for the task.",
            "nullable":true,
            "x-queryable":false
        },
        "AttachmentDocumentTypeId":{
            "title":"Document Type for Attachments",
            "type":"integer",
            "description":"Attachments to add to document records for the given document type.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ActivityAction5Label":{
            "maxLength":"120",
            "type":"string",
            "description":"Setting that enables to change the label of action 5.",
            "nullable":true,
            "x-queryable":false
        },
        "ActivityAction2Label":{
            "maxLength":"120",
            "type":"string",
            "description":"Setting that enables to change the label of action 2.",
            "nullable":true,
            "x-queryable":false
        },
        "ReminderRelativeTo":{
            "title":"Enable Reminder",
            "maxLength":"30",
            "type":"string",
            "description":"Task reminder that's relative either to due date or start date.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            }
        },
        "DocumentTypeId":{
            "title":"Document Type Identifier",
            "type":"integer",
            "description":"Identifier of the document type.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "Type":{
            "title":"Type Code",
            "maxLength":"80",
            "type":"string",
            "description":"Code for the task action type.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ReminderDuration":{
            "title":"Reminder Duration",
            "maxLength":"30",
            "type":"string",
            "description":"Duration of the task reminder, that's number of days between reminders.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ReminderRecurrence":{
            "title":"Reminder Recurrence",
            "maxLength":"30",
            "type":"string",
            "description":"Reminder for task recurrence, such as the number of times the reminders need to be sent.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "InitiatedFeedFlag":{
            "type":"boolean",
            "description":"Indicates whether the atom feed is enabled when a journey task is initiated.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "RequiredFlag":{
            "title":"Required",
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates whether the task is mandatory or optional. Valid values are Yes and No. The default value is No.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ActionURL":{
            "title":"URL",
            "maxLength":"1000",
            "type":"string",
            "description":"URL associated with the task. This task URL is returned as entered during setup.",
            "nullable":true,
            "x-queryable":false
        },
        "properties":{
            "title":"Properties",
            "type":"array",
            "description":"The properties resource is a child of the tasks resource. It includes display property settings for a task.",
            "items":{
                "$ref":"#/components/schemas/workerJourneyTasks-properties-item-patch-request"
            }
        },
        "ActionCompleteLabel":{
            "maxLength":"120",
            "type":"string",
            "description":"Setting that enables to change the label of the complete action.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Candidate Attachments

Type: array

Title: Candidate Attachments

The addresses resource is the child of the recruitingUICandidates resource and provides information about the addresses of a candidate.

Show Source

• Array of: object schema

{
    "title":"Candidate Attachments",
    "type":"array",
    "description":"The addresses resource is the child of the recruitingUICandidates resource and provides information about the addresses of a candidate.",
    "items":{
        "$ref":"#/components/schemas/workerJourneyTasks-attachments-item-patch-request"
    }
}

Nested Schema : Candidate Attachments

Type: array

Title: Candidate Attachments

The addresses resource is the child of the recruitingUICandidates resource and provides information about the addresses of a candidate.

Show Source

• Array of: object schema

{
    "title":"Candidate Attachments",
    "type":"array",
    "description":"The addresses resource is the child of the recruitingUICandidates resource and provides information about the addresses of a candidate.",
    "items":{
        "$ref":"#/components/schemas/workerJourneyTasks-documents-item-patch-request"
    }
}

Nested Schema : Learning Content Items List of Values

Type: array

Title: Learning Content Items List of Values

The learningContentItemsLOV resource provides a list of learning content items such as SCORM, HACP, PDF, video, assessment, and web link.

Show Source

• Array of: object workerJourneyTasks-learningItems-item-patch-request

{
    "title":"Learning Content Items List of Values",
    "type":"array",
    "description":"The learningContentItemsLOV resource provides a list of learning content items such as SCORM, HACP, PDF, video, assessment, and web link.",
    "items":{
        "$ref":"#/components/schemas/workerJourneyTasks-learningItems-item-patch-request"
    }
}

Nested Schema : Notifications

Type: array

Title: Notifications

The notifications resource is a child of the tasks resource. It includes notification settings for the task performer and owner.

Show Source

• Array of: object workerJourneyTasks-notifications-item-patch-request

{
    "title":"Notifications",
    "type":"array",
    "description":"The notifications resource is a child of the tasks resource. It includes notification settings for the task performer and owner.",
    "items":{
        "$ref":"#/components/schemas/workerJourneyTasks-notifications-item-patch-request"
    }
}

Nested Schema : Properties

Type: array

Title: Properties

The properties resource is a child of the tasks resource. It includes display property settings for a task.

Show Source

• Array of: object schema

{
    "title":"Properties",
    "type":"array",
    "description":"The properties resource is a child of the tasks resource. It includes display property settings for a task.",
    "items":{
        "$ref":"#/components/schemas/workerJourneyTasks-properties-item-patch-request"
    }
}

Nested Schema : Questionnaire Responses

Type: array

Title: Questionnaire Responses

The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.

Show Source

• Array of: object schema

{
    "title":"Questionnaire Responses",
    "type":"array",
    "description":"The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.",
    "items":{
        "$ref":"#/components/schemas/workerJourneyTasks-questionnaireResponses-item-patch-request"
    }
}

Nested Schema : tasksDFF

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/workerJourneyTasks-tasksDFF-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : schema

Type: object

Show Source

• CategoryName: string
  Title: Category

  Maximum Length: 30

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

  Indicates where the attachment is shared. If True, the attachment is shared.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  Value that indicates data type code of attachment.
• Description: string
  Title: Description

  Maximum Length: 255

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

  Unique identifier of the attachment.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Folder path of the attachment.
• DmVersionNumber: string
  Maximum Length: 255

  Version number of the attachment.
• 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

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

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

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

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

  Maximum Length: 2048

  File name of the attachment.
• FileUrl: string
  Title: File Url

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

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

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

  File content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  File length of the attachment.
• UploadedFileName: string
  Title: Uploaded File Name

  File name of the attachment.
• UploadedText: string
  Title: Uploaded Text

  Text of the attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

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

  Maximum Length: 4000

  URL of the attachment.

{
    "type":"object",
    "properties":{
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Error status message 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":"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":"Value that indicates data type code of attachment.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"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":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"URI of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"URL of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"File name of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"Unique identifier of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"URL of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates where the attachment is shared. If True, 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":"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":"File 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":"Expiration date and time of the attachment content.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Error status code 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":"Folder path of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"Category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"File length of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Version number of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• CategoryName: string
  Title: Category

  Maximum Length: 30

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

  Indicates where the attachment is shared. If True, the attachment is shared.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  Value that indicates data type code of attachment.
• Description: string
  Title: Description

  Maximum Length: 255

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

  Unique identifier of the attachment.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Folder path of the attachment.
• DmVersionNumber: string
  Maximum Length: 255

  Version number of the attachment.
• 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

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

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

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

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

  Maximum Length: 2048

  File name of the attachment.
• FileUrl: string
  Title: File Url

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

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

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

  File content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  File length of the attachment.
• UploadedFileName: string
  Title: Uploaded File Name

  File name of the attachment.
• UploadedText: string
  Title: Uploaded Text

  Text of the attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

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

  Maximum Length: 4000

  URL of the attachment.

{
    "type":"object",
    "properties":{
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Error status message 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":"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":"Value that indicates data type code of attachment.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"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":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"URI of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"URL of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"File name of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"Unique identifier of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"URL of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates where the attachment is shared. If True, 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":"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":"File 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":"Expiration date and time of the attachment content.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Error status code 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":"Folder path of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"Category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"File length of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Version number of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        }
    }
}

Nested Schema : workerJourneyTasks-learningItems-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : workerJourneyTasks-notifications-item-patch-request

Type: object

Show Source

• NotifyOwnerFlag: boolean
  Title: Notify Owner

  Maximum Length: 30

  Indicates whether the task owner needs to be notified when the event occurs. Valid values are Yes and No. The default value is No.
• NotifyPerformerFlag: boolean
  Title: Notify Performer

  Maximum Length: 30

  Indicates whether the task performer needs to be notified when the event occurs. Valid values are Yes and No. The default value is Yes.

{
    "type":"object",
    "properties":{
        "NotifyPerformerFlag":{
            "title":"Notify Performer",
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates whether the task performer needs to be notified when the event occurs. Valid values are Yes and No. The default value is Yes.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "NotifyOwnerFlag":{
            "title":"Notify Owner",
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates whether the task owner needs to be notified when the event occurs. Valid values are Yes and No. The default value is No.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• Category: string
  Name of the group for the journey task property.
• CategoryMeaning: string
  Meaning of the group for the journey task property.
• Code: string
  Code of the journey task property.
• DisabledForLineManagerFlag: boolean
  Indicates if the journey task property is disabled for line manager.
• DisabledForOthersFlag: boolean
  Indicates if the journey task property is disabled for other users.
• DisabledForOwnerFlag: boolean
  Indicates if the journey task property is disabled for task owner.
• DisabledForPerformerFlag: boolean
  Indicates if the journey task property is disabled for task performer.
• Level: string
  Level of the journey task property.
• LineManagerDefaultValue: string
  Default value of the journey task property for line manager.
• LineManagerLookupType: string
  Journey task property type for line manager.
• LineManagerValue: string
  Value of the journey task property for line manager.
• Name: string
  Name of the journey task property.
• OthersDefaultValue: string
  Default value of the journey task property for other user.
• OthersLookupType: string
  Journey task property type for other user.
• OthersValue: string
  Value of the journey task property for other user.
• OverriddenFlag: boolean
  Indicates if the journey task property is overridden.
• OwnerDefaultValue: string
  Default value of the journey task property for task owner.
• OwnerLookupType: string
  Journey task property type for task owner.
• OwnerValue: string
  Value of the journey task property for task owner.
• PerformerDefaultValue: string
  Default value of the journey task property for task performer.
• PerformerLookupType: string
  Journey task property type for task performer.
• PerformerValue: string
  Value of the journey task property for task performer.
• Sequence: integer
  Display order of the property.

{
    "type":"object",
    "properties":{
        "OthersDefaultValue":{
            "type":"string",
            "description":"Default value of the journey task property for other user.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "DisabledForPerformerFlag":{
            "type":"boolean",
            "description":"Indicates if the journey task property is disabled for task performer.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Category":{
            "type":"string",
            "description":"Name of the group for the journey task property.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "OthersValue":{
            "type":"string",
            "description":"Value of the journey task property for other user.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "LineManagerValue":{
            "type":"string",
            "description":"Value of the journey task property for line manager.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Sequence":{
            "type":"integer",
            "description":"Display order of the property.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Code":{
            "type":"string",
            "description":"Code of the journey task property.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "CategoryMeaning":{
            "type":"string",
            "description":"Meaning of the group for the journey task property.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Name":{
            "type":"string",
            "description":"Name of the journey task property.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "OthersLookupType":{
            "type":"string",
            "description":"Journey task property type for other user.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "DisabledForOwnerFlag":{
            "type":"boolean",
            "description":"Indicates if the journey task property is disabled for task owner.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "PerformerDefaultValue":{
            "type":"string",
            "description":"Default value of the journey task property for task performer.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "OverriddenFlag":{
            "type":"boolean",
            "description":"Indicates if the journey task property is overridden.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "PerformerValue":{
            "type":"string",
            "description":"Value of the journey task property for task performer.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "LineManagerDefaultValue":{
            "type":"string",
            "description":"Default value of the journey task property for line manager.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "DisabledForLineManagerFlag":{
            "type":"boolean",
            "description":"Indicates if the journey task property is disabled for line manager.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Level":{
            "type":"string",
            "description":"Level of the journey task property.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "PerformerLookupType":{
            "type":"string",
            "description":"Journey task property type for task performer.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "LineManagerLookupType":{
            "type":"string",
            "description":"Journey task property type for line manager.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "OwnerValue":{
            "type":"string",
            "description":"Value of the journey task property for task owner.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "OwnerLookupType":{
            "type":"string",
            "description":"Journey task property type for task owner.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "DisabledForOthersFlag":{
            "type":"boolean",
            "description":"Indicates if the journey task property is disabled for other users.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "OwnerDefaultValue":{
            "type":"string",
            "description":"Default value of the journey task property for task owner.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• QuestionnaireVersionNumber: integer (int64)
  Title: Questionnaire Version

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

  The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.
• Status: string
  Title: Response Status Code

  Maximum Length: 30

  Status of the questionnaire response. I denotes the response is in progress and not submitted yet, while S denotes a submitted response.

{
    "type":"object",
    "properties":{
        "Status":{
            "title":"Response Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"Status of the questionnaire response. I denotes the response is in progress and not submitted yet, while S denotes a submitted response.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            }
        },
        "questionResponses":{
            "title":"Question Responses",
            "type":"array",
            "description":"The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.",
            "items":{
                "$ref":"#/components/schemas/workerJourneyTasks-questionnaireResponses-questionResponses-item-patch-request"
            }
        },
        "QuestionnaireVersionNumber":{
            "title":"Questionnaire Version",
            "type":"integer",
            "description":"Version number of the questionnaire that the participant responds to.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            }
        }
    }
}

Nested Schema : Question Responses

Type: array

Title: Question Responses

The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.

Show Source

• Array of: object schema

{
    "title":"Question Responses",
    "type":"array",
    "description":"The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.",
    "items":{
        "$ref":"#/components/schemas/workerJourneyTasks-questionnaireResponses-questionResponses-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• AnswerCodeList: string
  Title: Answer Code List

  Concatenated list of answer choices, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.
• AnswerComments: string
  Title: Comments

  Maximum Length: 4000

  Additional comments provided by the participant when responding to a question.
• AnswerLargeObject: string (byte)
  Title: Answer

  Attachment provided by the participant when responding to a question.
• AnswerList: string
  Title: Answer List

  Maximum Length: 2000

  Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.
• ChoiceCodeList: string
  Title: Choice List Code

  Concatenated list of answer codes, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.
• QuestionAnswerId: integer (int64)
  Title: Question Answer Id

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

  The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.

{
    "type":"object",
    "properties":{
        "AnswerList":{
            "title":"Answer List",
            "maxLength":"2000",
            "type":"string",
            "description":"Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "questionResponseAttachments":{
            "title":"Question Response Attachments",
            "type":"array",
            "description":"The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.",
            "items":{
                "$ref":"#/components/schemas/workerJourneyTasks-questionnaireResponses-questionResponses-questionResponseAttachments-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":{
                "includeInCompactView":true,
                "precision":"18",
                "dependencies":[
                    "QuestionCode",
                    "QuestionId"
                ]
            }
        },
        "AnswerLargeObject":{
            "title":"Answer",
            "type":"string",
            "description":"Attachment provided by the participant when responding to a question.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ChoiceCodeList":{
            "title":"Choice List Code",
            "type":"string",
            "description":"Concatenated list of answer codes, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.",
            "nullable":true
        },
        "AnswerComments":{
            "title":"Comments",
            "maxLength":"4000",
            "type":"string",
            "description":"Additional comments provided by the participant when responding to a question.",
            "nullable":true
        },
        "AnswerCodeList":{
            "title":"Answer Code List",
            "type":"string",
            "description":"Concatenated list of answer choices, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.",
            "nullable":true
        }
    }
}

Nested Schema : Question Response Attachments

Type: array

Title: Question Response Attachments

The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.

Show Source

• Array of: object schema

{
    "title":"Question Response Attachments",
    "type":"array",
    "description":"The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.",
    "items":{
        "$ref":"#/components/schemas/workerJourneyTasks-questionnaireResponses-questionResponses-questionResponseAttachments-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• CategoryName: string
  Title: Category

  Maximum Length: 30

  Category name of the attachment. This is a read-only attribute.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the file can be shared. The default value is false and it's the only supported value.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

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

  Maximum Length: 255

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

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

  Maximum Length: 1000

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

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

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

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

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

  Expiration date of the attachment. This is a read-only attribute.
• FileContents: string (byte)
  Title: File Contents

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

  Maximum Length: 2048

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

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

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

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

  Content type of the uploaded file. This is a read-only attribute.
• UploadedFileLength: integer
  Title: File Size

  Size of the uploaded file. This is a read-only attribute.
• UploadedFileName: string
  Title: Uploaded File Name

  Name of the uploaded file. This is a read-only attribute.
• UploadedText: string
  Title: Uploaded Text

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

  Maximum Length: 4000

  URI of the attachment. This is a read-only attribute.
• Url: string
  Title: Url

  Maximum Length: 4000

  URL of a web page attachment.

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

Nested Schema : schema

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30
• __FLEX_Context_DisplayValue: string
  Title: Context Value

{
    "type":"object",
    "properties":{
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":"30",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

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

Type: object

Show Source

• AccessActivity: string
  Title: Access Task

  Read Only: true

  Setting that determines if the signed in user can access the task.
• AccessAttachments: string
  Title: Access Attachments

  Read Only: true

  Setting that determines if the signed in user can access the task attachments.
• AccessComments: string
  Title: Access Comments

  Read Only: true

  Setting that determines if the signed in user can access the task comments.
• AccessContact: string
  Title: Access Contact Information

  Read Only: true

  Setting that determines if the signed in user can access the task contact details.
• AccessNotes: string
  Title: Access Notes

  Read Only: true

  Setting that determines if the signed in user can access the task notes.
• ActionAddToCalendar: string
  Read Only: true

  Setting that determines if the signed in user can add the task to calendar.
• ActionAddToCalendarLabel: string
  Maximum Length: 120

  Setting that enables to change the label of the add to calendar action.
• ActionComplete: string
  Title: Mark as Complete

  Read Only: true

  Setting that determines if the signed in user can mark the task as complete.
• ActionCompleteLabel: string
  Maximum Length: 120

  Setting that enables to change the label of the complete action.
• ActionEdit: string
  Title: Edit

  Read Only: true

  Setting that determines if the signed in user can edit the task.
• ActionEditDueDate: string
  Title: Edit Due Date

  Read Only: true

  Setting that determines if the signed in user can edit the due date of the task.
• ActionReassign: string
  Title: Reassign

  Read Only: true

  Setting that determines if the signed in user can reassign the task.
• ActionReject: string
  Title: Mark as Not Applicable

  Read Only: true

  Setting that determines if the signed in user can mark the task as not applicable.
• ActionRejectLabel: string
  Maximum Length: 120

  Setting that enables to change the label of the not applicable action.
• ActionRemove: string
  Title: Remove

  Read Only: true

  Setting that determines if the signed in user can remove the task.
• ActionReopen: string
  Title: Reopen

  Read Only: true

  Setting that determines if the signed in user can reopen a completed task.
• ActionSave: string
  Read Only: true

  Setting that determines if the signed in user can save an incomplete task.
• ActionSaveLabel: string
  Maximum Length: 120

  Setting that enables to change the label of the save as draft action.
• ActionURL: string
  Title: URL

  Maximum Length: 1000

  URL associated with the task. This task URL is returned as entered during setup.
• ActivityAction1Label: string
  Maximum Length: 120

  Setting that enables to change the label of action 1.
• ActivityAction2Label: string
  Maximum Length: 120

  Setting that enables to change the label of action 2.
• ActivityAction3Label: string
  Maximum Length: 120

  Setting that enables to change the label of action 3.
• ActivityAction4Label: string
  Maximum Length: 120

  Setting that enables to change the label of action 4.
• ActivityAction5Label: string
  Maximum Length: 120

  Setting that enables to change the label of action 5.
• ActualEndDate: string (date)
  Title: Actual End Date

  Date on which the task was completed.
• ActualStartDate: string (date)
  Title: Actual Start Date

  Date on which the task was opened.
• AddAttachmentsToDORFlag: boolean
  Setting that determines if attachments can be stored in Document Records.
• AddToCalendar: string (byte)
  Read Only: true

  Option to add task to calendar.
• AllowAttachmentFlag: boolean
  Title: Allow Attachments

  Indicates whether attachments are enabled for a task. Valid values are Yes or No. The default value is No.
• AllowCommentFlag: boolean
  Title: Allow Comments

  Indicates whether comments are enabled for a task. Valid values are Yes or No. The default value is No.
• AllowNotesContentFlag: boolean
  Indicates whether rich content can be added for notes. Valid values are Yes or No. The default is Yes.
• AllowNoteTitleFlag: boolean
  Title: Enable Notes Title

  Read Only: true

  Indicates whether the Notes title is hidden or not. Valid values are Yes and No. The default value is No.
• AnalysisParameters: string
  Read Only: true

  Maximum Length: 4000

  Parameters associated with an analytics task type.
• AnalysisPath: string
  Read Only: true

  Maximum Length: 1000

  OTBI analysis path for an analytics task type.
• ApplicationTaskName: string
  Title: Application Task

  Read Only: true

  Application task name.
• AttachmentDocumentTypeId: integer (int64)
  Title: Document Type for Attachments

  Attachments to add to document records for the given document type.
• attachments: array Candidate Attachments
  Title: Candidate Attachments

  The addresses resource is the child of the recruitingUICandidates resource and provides information about the addresses of a candidate.
• AuthenticationFormat: string
  Read Only: true

  Password authentication format of an electronic signature task.
• AuthenticationInstructionText: string
  Read Only: true

  Instruction text used in the password authentication of an electronic signature task.
• Comments: string
  Title: Comments

  Maximum Length: 4000

  Comments for the task.
• CompletedByDisplayName: string
  Title: Completed by Person Name

  Read Only: true

  Display name of the person who completed the task.
• CompletedByPersonId: integer
  Title: Completed by Person ID

  Read Only: true

  Person identifier of the person who completed the task
• CompletedFeedFlag: boolean
  Indicates whether the atom feed is enabled when a journey task is completed.
• CompletionDate: string (date)
  Title: Completed On

  Read Only: true

  Date on which the task was completed.
• ConfigurableFormContext: string
  Title: Configurable Form

  Read Only: true

  Maximum Length: 80

  Flexfield context code for configurable form task type.
• ContentProviderCode: string
  Maximum Length: 240

  Code of the user-defined content task.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the journey task.
• CreationDate: string (date-time)
  Read Only: true

  Date on which the journey task was created.
• DeferredStartDate: string (date)
  Title: Deferred Task Start Date

  Read Only: true

  Deferred start date for a deferred task.
• DeletedFeedFlag: boolean
  Indicates whether the atom feed is enabled when a journey task is deleted.
• DependentTaskId: integer (int64)
  Title: Preceding Task ID

  Read Only: true

  Unique identifier of the dependent task.
• DependentTaskName: string
  Title: Preceding Task

  Read Only: true

  Maximum Length: 240

  Name of the dependent task.
• Description: string
  Title: Description

  Maximum Length: 4000

  Description of the task.
• DisplayOptions: string
  Read Only: true

  Maximum Length: 4000

  Type of OTBI analysis.
• documents: array Candidate Attachments
  Title: Candidate Attachments

  The addresses resource is the child of the recruitingUICandidates resource and provides information about the addresses of a candidate.
• DocumentTypeId: integer (int64)
  Title: Document Type Identifier

  Identifier of the document type.
• DocumentTypeName: string
  Title: Document Type

  Read Only: true

  Maximum Length: 80

  Name of the document type.
• EmbeddedApplicationTaskCode: string
  Read Only: true

  Maximum Length: 240

  Code of the embedded application task.
• EmbeddedApplicationTaskTypeId: integer (int64)
  Read Only: true

  Unique identifier of the embedded application task.
• EnableEmailFlag: boolean
  Read Only: true

  Indicates whether the email field is enabled for a native electronic signature journey task.
• EnableExpiryFlag: boolean
  Maximum Length: 4

  Indicates whether the task should expire. Valid values are Yes and No. The default value is No.
• EnableSignatureFlag: boolean
  Read Only: true

  Indicates whether the signature field is enabled for a native electronic signature journey task.
• ErrorDetails: string
  Read Only: true

  Error details, if any, for the task.
• ErrorMessage: string
  Read Only: true

  Error message, if any, for the task.
• ErrorType: string
  Read Only: true

  Error type, if any, for the task.
• ExpiryDate: string (date)
  Date on which the journey task expires.
• ExpiryDuration: integer (int32)
  Title: Expiry Days

  Duration after which the task expires.
• ExpiryRelativeTo: string
  Maximum Length: 30

  Criteria based on which the task expires.
• ExpiryRelativeToMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Meaning of the criteria based on which the task expires.
• FeedFlag: boolean
  Indicates whether the atom feed is enabled for a journey task.
• InitiatedFeedFlag: boolean
  Indicates whether the atom feed is enabled when a journey task is initiated.
• JourneyActionDate: string (date)
  Title: Action Date

  Read Only: true

  Date on which the journey action occurs.
• JourneyAssignmentId: integer (int64)
  Read Only: true

  Unique assignment identifier of the journey assignee.
• JourneyCategory: string
  Title: Category Code

  Read Only: true

  Maximum Length: 60

  Category of the journey.
• JourneyInstance: string
  Title: Instance

  Read Only: true

  Maximum Length: 255

  Instance of the journey.
• JourneyName: string
  Title: Journey Name

  Read Only: true

  Maximum Length: 255

  Name of the journey.
• JourneyPersonId: integer (int64)
  Title: Person ID

  Read Only: true

  Unique person identifier of the journey assignee.
• JourneyPersonName: string
  Title: Person Name

  Read Only: true

  Maximum Length: 240

  Display name of the journey assignee.
• JourneyPersonNumber: string
  Title: Person Number

  Read Only: true

  Maximum Length: 255

  Person number of the journey assignee.
• JourneySubCategory: string
  Read Only: true

  Maximum Length: 60

  Subcategory of the worker journey.
• JourneySubCategoryMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Subcategory meaning of the worker journey.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date on which the task was updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the task.
• LearnCommunityId: integer (int64)
  Identifier of the learning community.
• LearnEnrollmentId: integer (int64)
  Identifier of the learning enrollment.
• LearnEnrollmentType: string
  Maximum Length: 80

  Type of learning enrollment.
• LearningContentType: string
  Read Only: true

  Maximum Length: 80

  Type of learning content.
• LearningContentTypeMeaning: string
  Read Only: true

  Meaning of the learning content type.
• LearningItemId: integer (int64)
  Read Only: true

  Unique identifier of the learning item.
• learningItems: array Learning Content Items List of Values
  Title: Learning Content Items List of Values

  The learningContentItemsLOV resource provides a list of learning content items such as SCORM, HACP, PDF, video, assessment, and web link.
• links: array Links
  Title: Links

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

  Maximum Length: 240

  Name of the task.
• Notes: string (byte)
  Title: Notes

  Notes for a task. The notes text is stored as a CLOB object. To use in the payload, the text should be converted to a base64 encoded string using either a conversion tool or a prerequisite script.
• NoteTitle: string
  Title: Notes Title

  Read Only: true

  Maximum Length: 150

  Title of the Notes section in the task.
• notifications: array Notifications
  Title: Notifications

  The notifications resource is a child of the tasks resource. It includes notification settings for the task performer and owner.
• ObjectReferenceId: integer (int64)
  Read Only: true

  Reference identifier of the journey template object.
• OpenInSamePageFlag: boolean
  Read Only: true

  Indicates whether the external URL should open in the existing page or a new page. Valid values are Yes and No. The default value is No.
• OpenReportInSamePageFlag: boolean
  Read Only: true

  Indicates whether the report should open in the same page is enabled for native electronic signature or report journey task.
• OwnerName: string
  Title: Owner Name

  Read Only: true

  Task owner name. Displays person name if there is a single task owner else displays responsibility type name.
• OwnerPersonId: integer (int64)
  Title: Owner Person ID

  Read Only: true

  Person identifier of the task owner. Available only in case of single owner.
• OwnerType: string
  Title: Owner Type

  Read Only: true

  Maximum Length: 30

  Task owner type.
• OwnerTypeMeaning: string
  Title: Owner

  Read Only: true

  Task owner type meaning.
• OwnerWorkEmailAddress: string
  Title: Email

  Read Only: true

  Maximum Length: 240

  Work email of the owner.
• ParentWorkerJourneyId: integer (int64)
  Title: Worker Journey ID

  Read Only: true

  Identifier of the parent enterprise onboarding checklist. Not applicable for other checklist categories.
• PerformerName: string
  Title: Performer Name

  Read Only: true

  Name of the performer. In case of single performer returns the performer person display name else return responsibility type name.
• PerformerPersonId: integer (int64)
  Title: Performer Person ID

  Read Only: true

  Person identifier of the task performer. Available only in case of single performer.
• PerformerType: string
  Title: Performer Type

  Read Only: true

  Task performer type.
• PerformerTypeMeaning: string
  Title: Performer

  Read Only: true

  Task performer type meaning.
• properties: array Properties
  Title: Properties

  The properties resource is a child of the tasks resource. It includes display property settings for a task.
• QuestionnaireId: integer (int64)
  Title: Questionnaire

  Read Only: true

  Unique identifier of a questionnaire.
• QuestionnaireName: string
  Title: Name

  Read Only: true

  Maximum Length: 240

  Name of the questionnaire.
• questionnaireResponses: array Questionnaire Responses
  Title: Questionnaire Responses

  The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.
• ReassignedFeedFlag: boolean
  Indicates whether the atom feed is enabled when a journey task is reassigned.
• ReminderDuration: string
  Title: Reminder Duration

  Maximum Length: 30

  Duration of the task reminder, that's number of days between reminders.
• ReminderRecurrence: string
  Title: Reminder Recurrence

  Maximum Length: 30

  Reminder for task recurrence, such as the number of times the reminders need to be sent.
• ReminderRelativeTo: string
  Title: Enable Reminder

  Maximum Length: 30

  Task reminder that's relative either to due date or start date.
• ReportPath: string
  Title: Report Path

  Read Only: true

  Maximum Length: 1000

  Path to the report in BI Catalog
• RequiredFlag: boolean
  Title: Required

  Maximum Length: 30

  Indicates whether the task is mandatory or optional. Valid values are Yes and No. The default value is No.
• SaveAttachmentsToDORFor: string
  Task attachment to save to document records.
• SaveAttachmentsToDORForMeaning: string
  Read Only: true

  Meaning of save attachments to document records.
• SaveDocumentsToDORFor: string
  Read Only: true

  Attachments to add to document records for a document type.
• SaveDocumentsToDORForMeaning: string
  Read Only: true

  Meaning of add attachments to document record.
• Sequence: integer (int32)
  Title: Sequence

  Task display ordering sequence, if specified.
• SignAddress: string
  Title: IP Address of Signature

  Maximum Length: 120

  Internet protocol address where the electronic signature was provided.
• SignatureImageData: string (byte)
  Signature of the user in a native electronic signature task.
• SignatureNameValidation: string
  Read Only: true

  Validation type for name in native electronic signature.
• SignatureValidationMode: string
  Read Only: true

  Validation option for an electronic signature.
• SignDate: string (date)
  Title: Date of Signature

  Read Only: true

  Date on which the electronic signature was provided for an electronic signature task.
• SignerAuthentication: string
  Authentication password of the signer in an electronic signature task.
• SignerEmail: string
  Title: Email of Signer

  Maximum Length: 400

  Email address of the signer for an electronic signature task.
• SignerName: string
  Title: Name of Signer

  Maximum Length: 120

  Name of the signer for an electronic signature task.
• Status: string
  Title: Status Code

  Maximum Length: 60

  Status code of the task.
• StatusCategory: string
  Title: Status Category

  Read Only: true

  Maximum Length: 80

  Category of the task status.
• StatusMeaning: string
  Title: Status

  Read Only: true

  Maximum Length: 80

  Status of the task.
• SubType: string
  Title: Subtype Code

  Read Only: true

  Maximum Length: 30

  Task action subtype code. Available only for I 9 and Electronic Signature task types.
• SubTypeMeaning: string
  Title: Subtype

  Read Only: true

  Task action subtype. Available only for I 9 and Electronic Signature task types.
• TargetEndDate: string (date)
  Title: Target End Date

  Due date of the task.
• TargetStartDate: string (date)
  Title: Target Start Date

  Expected initiation date of the task.
• TaskCompletionEnabledFlag: boolean
  Indicates if the task can be completed.
• tasksDFF: array tasksDFF
• Type: string
  Title: Type Code

  Maximum Length: 80

  Code for the task action type.
• TypeMeaning: string
  Title: Type

  Read Only: true

  Maximum Length: 80

  Task action type.
• VideoType: string
  Read Only: true

  Maximum Length: 80

  Type of video.
• VideoTypeMeaning: string
  Read Only: true

  Meaning of video type.
• VideoURL: string
  Read Only: true

  Maximum Length: 1000

  URL of the video.
• WorkAuthorizationProgressStatus: string
  Read Only: true

  I 9 progress status code that displays if the I 9 process is completed.
• WorkAuthorizationProgressStatusMeaning: string
  Read Only: true

  I 9 progress status that displays if the I 9 process is completed.
• WorkAuthorizationVerificationStatus: string
  Read Only: true

  I 9 verification status code.
• WorkAuthorizationVerificationStatusMeaning: string
  Read Only: true

  I 9 verification status.
• WorkerJourneyId: integer (int64)
  Title: Worker Journey ID

  Read Only: true

  Unique identifier of the journey.
• WorkerJourneyTaskId: integer (int64)
  Title: Journey Task ID

  Read Only: true

  Unique identifier of the journey task.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date on which the journey task was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SaveDocumentsToDORForMeaning":{
            "type":"string",
            "description":"Meaning of add attachments to document record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "SaveDocumentsToDORFor"
                ]
            }
        },
        "AddAttachmentsToDORFlag":{
            "type":"boolean",
            "description":"Setting that determines if attachments can be stored in Document Records.",
            "nullable":true,
            "x-queryable":false
        },
        "DisplayOptions":{
            "maxLength":"4000",
            "type":"string",
            "description":"Type of OTBI analysis.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ActionSaveLabel":{
            "maxLength":"120",
            "type":"string",
            "description":"Setting that enables to change the label of the save as draft action.",
            "nullable":true,
            "x-queryable":false
        },
        "ActionComplete":{
            "title":"Mark as Complete",
            "type":"string",
            "description":"Setting that determines if the signed in user can mark the task as complete.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SignAddress":{
            "title":"IP Address of Signature",
            "maxLength":"120",
            "type":"string",
            "description":"Internet protocol address where the electronic signature was provided.",
            "nullable":true,
            "x-queryable":false
        },
        "SaveAttachmentsToDORForMeaning":{
            "type":"string",
            "description":"Meaning of save attachments to document records.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "SaveAttachmentsToDORFor"
                ]
            }
        },
        "ActualStartDate":{
            "title":"Actual Start Date",
            "type":"string",
            "description":"Date on which the task was opened.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "WorkAuthorizationVerificationStatusMeaning":{
            "type":"string",
            "description":"I 9 verification status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "VideoTypeMeaning":{
            "type":"string",
            "description":"Meaning of video type.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "VideoType"
                ]
            },
            "x-queryable":true
        },
        "AccessComments":{
            "title":"Access Comments",
            "type":"string",
            "description":"Setting that determines if the signed in user can access the task comments.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ActivityAction1Label":{
            "maxLength":"120",
            "type":"string",
            "description":"Setting that enables to change the label of action 1.",
            "nullable":true,
            "x-queryable":false
        },
        "OwnerType":{
            "title":"Owner Type",
            "maxLength":"30",
            "type":"string",
            "description":"Task owner type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ExpiryRelativeToMeaning":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of the criteria based on which the task expires.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "AllowAttachmentFlag":{
            "title":"Allow Attachments",
            "type":"boolean",
            "description":"Indicates whether attachments are enabled for a task. Valid values are Yes or No. The default value is No.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "OwnerWorkEmailAddress":{
            "title":"Email",
            "maxLength":"240",
            "type":"string",
            "description":"Work email of the owner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OwnerTypeMeaning":{
            "title":"Owner",
            "type":"string",
            "description":"Task owner type meaning.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "OwnerRespTypeMeaning",
                    "OwnerLookupMeaning"
                ]
            }
        },
        "QuestionnaireId":{
            "title":"Questionnaire",
            "type":"integer",
            "description":"Unique identifier of a questionnaire.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "SignatureValidationMode":{
            "type":"string",
            "description":"Validation option for an electronic signature.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "BasicEsignConfigAttributes"
                ]
            }
        },
        "SaveDocumentsToDORFor":{
            "type":"string",
            "description":"Attachments to add to document records for a document type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LearnCommunityId":{
            "type":"integer",
            "description":"Identifier of the learning community.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "LearnEnrollmentId":{
            "type":"integer",
            "description":"Identifier of the learning enrollment.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who last updated the task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Status":{
            "title":"Status Code",
            "maxLength":"60",
            "type":"string",
            "description":"Status code of the task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DependentTaskId":{
            "title":"Preceding Task ID",
            "type":"integer",
            "description":"Unique identifier of the dependent task.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the journey task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "learningItems":{
            "title":"Learning Content Items List of Values",
            "type":"array",
            "description":"The learningContentItemsLOV resource provides a list of learning content items such as SCORM, HACP, PDF, video, assessment, and web link.",
            "items":{
                "$ref":"#/components/schemas/workerJourneyTasks-learningItems-item-response"
            }
        },
        "TargetEndDate":{
            "title":"Target End Date",
            "type":"string",
            "description":"Due date of the task.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "WorkAuthorizationProgressStatus":{
            "type":"string",
            "description":"I 9 progress status code that displays if the I 9 process is completed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "I9Attributes"
                ]
            }
        },
        "FeedFlag":{
            "type":"boolean",
            "description":"Indicates whether the atom feed is enabled for a journey task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "tasksDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/workerJourneyTasks-tasksDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "questionnaireResponses":{
            "title":"Questionnaire Responses",
            "type":"array",
            "description":"The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.",
            "items":{
                "$ref":"#/components/schemas/workerJourneyTasks-questionnaireResponses-item-response"
            }
        },
        "WorkAuthorizationProgressStatusMeaning":{
            "type":"string",
            "description":"I 9 progress status that displays if the I 9 process is completed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CompletedByPersonId":{
            "title":"Completed by Person ID",
            "type":"integer",
            "description":"Person identifier of the person who completed the task",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SignatureNameValidation":{
            "type":"string",
            "description":"Validation type for name in native electronic signature.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "BasicEsignConfigAttributes"
                ]
            }
        },
        "notifications":{
            "title":"Notifications",
            "type":"array",
            "description":"The notifications resource is a child of the tasks resource. It includes notification settings for the task performer and owner.",
            "items":{
                "$ref":"#/components/schemas/workerJourneyTasks-notifications-item-response"
            }
        },
        "DocumentTypeName":{
            "title":"Document Type",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the document type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ActionAddToCalendar":{
            "type":"string",
            "description":"Setting that determines if the signed in user can add the task to calendar.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Description":{
            "title":"Description",
            "maxLength":"4000",
            "type":"string",
            "description":"Description of the task.",
            "nullable":true,
            "x-queryable":false
        },
        "SaveAttachmentsToDORFor":{
            "type":"string",
            "description":"Task attachment to save to document records.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "attachments":{
            "title":"Candidate Attachments",
            "type":"array",
            "description":"The addresses resource is the child of the recruitingUICandidates resource and provides information about the addresses of a candidate.",
            "items":{
                "$ref":"#/components/schemas/workerJourneyTasks-attachments-item-response"
            }
        },
        "ActivityAction3Label":{
            "maxLength":"120",
            "type":"string",
            "description":"Setting that enables to change the label of action 3.",
            "nullable":true,
            "x-queryable":false
        },
        "LearnEnrollmentType":{
            "maxLength":"80",
            "type":"string",
            "description":"Type of learning enrollment.",
            "nullable":true,
            "x-queryable":false
        },
        "JourneyInstance":{
            "title":"Instance",
            "maxLength":"255",
            "type":"string",
            "description":"Instance of the journey.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "dependencies":[
                    "MasterJourneyInstance",
                    "ParentJourneyInstance"
                ]
            },
            "x-queryable":true
        },
        "ApplicationTaskName":{
            "title":"Application Task",
            "type":"string",
            "description":"Application task name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SignDate":{
            "title":"Date of Signature",
            "type":"string",
            "description":"Date on which the electronic signature was provided for an electronic signature task.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CompletedFeedFlag":{
            "type":"boolean",
            "description":"Indicates whether the atom feed is enabled when a journey task is completed.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ErrorDetails":{
            "type":"string",
            "description":"Error details, if any, for the task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "WorkerJourneyTaskId":{
            "title":"Journey Task ID",
            "type":"integer",
            "description":"Unique identifier of the journey task.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "AllowNoteTitleFlag":{
            "title":"Enable Notes Title",
            "type":"boolean",
            "description":"Indicates whether the Notes title is hidden or not. Valid values are Yes and No. The default value is No.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "TaskCompletionEnabledFlag":{
            "type":"boolean",
            "description":"Indicates if the task can be completed.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "WorkerJourneyId":{
            "title":"Worker Journey ID",
            "type":"integer",
            "description":"Unique identifier of the journey.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"80"
            },
            "x-queryable":true
        },
        "ActivityAction4Label":{
            "maxLength":"120",
            "type":"string",
            "description":"Setting that enables to change the label of action 4.",
            "nullable":true,
            "x-queryable":false
        },
        "StatusCategory":{
            "title":"Status Category",
            "maxLength":"80",
            "type":"string",
            "description":"Category of the task status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SubTypeMeaning":{
            "title":"Subtype",
            "type":"string",
            "description":"Task action subtype. Available only for I 9 and Electronic Signature task types.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "EsignTypeMeaning",
                    "I9TypeMeaning",
                    "ProcessAutomationTypeMeaning",
                    "VideoTypeLookupMeaning",
                    "LearnTypeMeaning"
                ]
            }
        },
        "ErrorType":{
            "type":"string",
            "description":"Error type, if any, for the task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EnableSignatureFlag":{
            "type":"boolean",
            "description":"Indicates whether the signature field is enabled for a native electronic signature journey task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "BasicEsignConfigAttributes"
                ]
            }
        },
        "AnalysisParameters":{
            "maxLength":"4000",
            "type":"string",
            "description":"Parameters associated with an analytics task type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SignerAuthentication":{
            "type":"string",
            "description":"Authentication password of the signer in an electronic signature task.",
            "nullable":true,
            "x-queryable":true
        },
        "EnableExpiryFlag":{
            "maxLength":"4",
            "type":"boolean",
            "description":"Indicates whether the task should expire. Valid values are Yes and No. The default value is No.",
            "nullable":true,
            "x-queryable":false
        },
        "QuestionnaireName":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the questionnaire.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ConfigurableFormContext":{
            "title":"Configurable Form",
            "maxLength":"80",
            "type":"string",
            "description":"Flexfield context code for configurable form task type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CompletionDate":{
            "title":"Completed On",
            "type":"string",
            "description":"Date on which the task was completed.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ActionRemove":{
            "title":"Remove",
            "type":"string",
            "description":"Setting that determines if the signed in user can remove the task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "JourneyPersonId":{
            "title":"Person ID",
            "type":"integer",
            "description":"Unique person identifier of the journey assignee.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "JourneyPersonName":{
            "title":"Person Name",
            "maxLength":"240",
            "type":"string",
            "description":"Display name of the journey assignee.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AccessAttachments":{
            "title":"Access Attachments",
            "type":"string",
            "description":"Setting that determines if the signed in user can access the task attachments.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ReminderRelativeTo":{
            "title":"Enable Reminder",
            "maxLength":"30",
            "type":"string",
            "description":"Task reminder that's relative either to due date or start date.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            }
        },
        "EmbeddedApplicationTaskTypeId":{
            "type":"integer",
            "description":"Unique identifier of the embedded application task.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "VideoURL":{
            "maxLength":"1000",
            "type":"string",
            "description":"URL of the video.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DocumentTypeId":{
            "title":"Document Type Identifier",
            "type":"integer",
            "description":"Identifier of the document type.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "AccessNotes":{
            "title":"Access Notes",
            "type":"string",
            "description":"Setting that determines if the signed in user can access the task notes.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Type":{
            "title":"Type Code",
            "maxLength":"80",
            "type":"string",
            "description":"Code for the task action type.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "JourneySubCategory":{
            "maxLength":"60",
            "type":"string",
            "description":"Subcategory of the worker journey.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ReminderRecurrence":{
            "title":"Reminder Recurrence",
            "maxLength":"30",
            "type":"string",
            "description":"Reminder for task recurrence, such as the number of times the reminders need to be sent.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "OpenReportInSamePageFlag":{
            "type":"boolean",
            "description":"Indicates whether the report should open in the same page is enabled for native electronic signature or report journey task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ReportPath":{
            "title":"Report Path",
            "maxLength":"1000",
            "type":"string",
            "description":"Path to the report in BI Catalog",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "JourneyAssignmentId":{
            "type":"integer",
            "description":"Unique assignment identifier of the journey assignee.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "InitiatedFeedFlag":{
            "type":"boolean",
            "description":"Indicates whether the atom feed is enabled when a journey task is initiated.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "AccessActivity":{
            "title":"Access Task",
            "type":"string",
            "description":"Setting that determines if the signed in user can access the task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LearningContentTypeMeaning":{
            "type":"string",
            "description":"Meaning of the learning content type.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "LearningContentType"
                ]
            },
            "x-queryable":true
        },
        "RequiredFlag":{
            "title":"Required",
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates whether the task is mandatory or optional. Valid values are Yes and No. The default value is No.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ActionURL":{
            "title":"URL",
            "maxLength":"1000",
            "type":"string",
            "description":"URL associated with the task. This task URL is returned as entered during setup.",
            "nullable":true,
            "x-queryable":false
        },
        "ErrorMessage":{
            "type":"string",
            "description":"Error message, if any, for the task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date on which the task was updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SignatureImageData":{
            "type":"string",
            "description":"Signature of the user in a native electronic signature task.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ExpiryDate":{
            "type":"string",
            "description":"Date on which the journey task expires.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "AuthenticationFormat":{
            "type":"string",
            "description":"Password authentication format of an electronic signature task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "BasicEsignConfigAttributes"
                ]
            }
        },
        "ContentProviderCode":{
            "maxLength":"240",
            "type":"string",
            "description":"Code of the user-defined content task.",
            "nullable":true,
            "x-queryable":false
        },
        "documents":{
            "title":"Candidate Attachments",
            "type":"array",
            "description":"The addresses resource is the child of the recruitingUICandidates resource and provides information about the addresses of a candidate.",
            "items":{
                "$ref":"#/components/schemas/workerJourneyTasks-documents-item-response"
            }
        },
        "DeferredStartDate":{
            "title":"Deferred Task Start Date",
            "type":"string",
            "description":"Deferred start date for a deferred task.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LearningContentType":{
            "maxLength":"80",
            "type":"string",
            "description":"Type of learning content.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EmbeddedApplicationTaskCode":{
            "maxLength":"240",
            "type":"string",
            "description":"Code of the embedded application task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "WorkAuthorizationVerificationStatus":{
            "type":"string",
            "description":"I 9 verification status code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "I9Attributes"
                ]
            }
        },
        "ActionRejectLabel":{
            "maxLength":"120",
            "type":"string",
            "description":"Setting that enables to change the label of the not applicable action.",
            "nullable":true,
            "x-queryable":false
        },
        "Name":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the task.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PerformerTypeMeaning":{
            "title":"Performer",
            "type":"string",
            "description":"Task performer type meaning.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "RespPerformerAvailability",
                    "ResponsibilityTypeMeaning",
                    "PerformerLookupMeaning",
                    "DefaultRespTypeMeaning"
                ]
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DeletedFeedFlag":{
            "type":"boolean",
            "description":"Indicates whether the atom feed is enabled when a journey task is deleted.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "SignerEmail":{
            "title":"Email of Signer",
            "maxLength":"400",
            "type":"string",
            "description":"Email address of the signer for an electronic signature task.",
            "nullable":true,
            "x-queryable":false
        },
        "NoteTitle":{
            "title":"Notes Title",
            "maxLength":"150",
            "type":"string",
            "description":"Title of the Notes section in the task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EnableEmailFlag":{
            "type":"boolean",
            "description":"Indicates whether the email field is enabled for a native electronic signature journey task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "BasicEsignConfigAttributes"
                ]
            }
        },
        "ReassignedFeedFlag":{
            "type":"boolean",
            "description":"Indicates whether the atom feed is enabled when a journey task is reassigned.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "SubType":{
            "title":"Subtype Code",
            "maxLength":"30",
            "type":"string",
            "description":"Task action subtype code. Available only for I 9 and Electronic Signature task types.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "DependentTaskName":{
            "title":"Preceding Task",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the dependent task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "TargetStartDate":{
            "title":"Target Start Date",
            "type":"string",
            "description":"Expected initiation date of the task.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "PerformerPersonId":{
            "title":"Performer Person ID",
            "type":"integer",
            "description":"Person identifier of the task performer. Available only in case of single performer.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "Sequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"Task display ordering sequence, if specified.",
            "format":"int32",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "ActionEdit":{
            "title":"Edit",
            "type":"string",
            "description":"Setting that determines if the signed in user can edit the task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AllowNotesContentFlag":{
            "type":"boolean",
            "description":"Indicates whether rich content can be added for notes. Valid values are Yes or No. The default is Yes.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "JourneyCategory":{
            "title":"Category Code",
            "maxLength":"60",
            "type":"string",
            "description":"Category of the journey.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ActionReject":{
            "title":"Mark as Not Applicable",
            "type":"string",
            "description":"Setting that determines if the signed in user can mark the task as not applicable.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PerformerName":{
            "title":"Performer Name",
            "type":"string",
            "description":"Name of the performer. In case of single performer returns the performer person display name else return responsibility type name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PerformerPersonId",
                    "PerformerType",
                    "PerformerDisplayName",
                    "PerformerTypeMeaning"
                ]
            }
        },
        "OpenInSamePageFlag":{
            "type":"boolean",
            "description":"Indicates whether the external URL should open in the existing page or a new page. Valid values are Yes and No. The default value is No.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LearningItemId":{
            "type":"integer",
            "description":"Unique identifier of the learning item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ParentWorkerJourneyId":{
            "title":"Worker Journey ID",
            "type":"integer",
            "description":"Identifier of the parent enterprise onboarding checklist. Not applicable for other checklist categories.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "ActionSave":{
            "type":"string",
            "description":"Setting that determines if the signed in user can save an incomplete task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OwnerName":{
            "title":"Owner Name",
            "type":"string",
            "description":"Task owner name. Displays person name if there is a single task owner else displays responsibility type name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "OwnerPersonId",
                    "OwnerType",
                    "OwnerDisplayName",
                    "OwnerTypeMeaning"
                ]
            }
        },
        "AddToCalendar":{
            "type":"string",
            "description":"Option to add task to calendar.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AuthenticationInstructionText":{
            "type":"string",
            "description":"Instruction text used in the password authentication of an electronic signature task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "BasicEsignConfigAttributes"
                ]
            }
        },
        "AccessContact":{
            "title":"Access Contact Information",
            "type":"string",
            "description":"Setting that determines if the signed in user can access the task contact details.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ExpiryRelativeTo":{
            "maxLength":"30",
            "type":"string",
            "description":"Criteria based on which the task expires.",
            "nullable":true,
            "x-queryable":false
        },
        "JourneyActionDate":{
            "title":"Action Date",
            "type":"string",
            "description":"Date on which the journey action occurs.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "VideoType":{
            "maxLength":"80",
            "type":"string",
            "description":"Type of video.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AllowCommentFlag":{
            "title":"Allow Comments",
            "type":"boolean",
            "description":"Indicates whether comments are enabled for a task. Valid values are Yes or No. The default value is No.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ActionAddToCalendarLabel":{
            "maxLength":"120",
            "type":"string",
            "description":"Setting that enables to change the label of the add to calendar action.",
            "nullable":true,
            "x-queryable":false
        },
        "AnalysisPath":{
            "maxLength":"1000",
            "type":"string",
            "description":"OTBI analysis path for an analytics task type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ActionReassign":{
            "title":"Reassign",
            "type":"string",
            "description":"Setting that determines if the signed in user can reassign the task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ActionReopen":{
            "title":"Reopen",
            "type":"string",
            "description":"Setting that determines if the signed in user can reopen a completed task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SignerName":{
            "title":"Name of Signer",
            "maxLength":"120",
            "type":"string",
            "description":"Name of the signer for an electronic signature task.",
            "nullable":true,
            "x-queryable":false
        },
        "ActionEditDueDate":{
            "title":"Edit Due Date",
            "type":"string",
            "description":"Setting that determines if the signed in user can edit the due date of the task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "JourneyName":{
            "title":"Journey Name",
            "maxLength":"255",
            "type":"string",
            "description":"Name of the journey.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "dependencies":[
                    "JourneyInstance",
                    "MasterJourneyName",
                    "ParentJourneyName",
                    "ChecklistDisplayName"
                ]
            },
            "x-queryable":true
        },
        "ObjectReferenceId":{
            "type":"integer",
            "description":"Reference identifier of the journey template object.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "CompletedByDisplayName":{
            "title":"Completed by Person Name",
            "type":"string",
            "description":"Display name of the person who completed the task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Notes":{
            "title":"Notes",
            "type":"string",
            "description":"Notes for a task. The notes text is stored as a CLOB object. To use in the payload, the text should be converted to a base64 encoded string using either a conversion tool or a prerequisite script.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ActualEndDate":{
            "title":"Actual End Date",
            "type":"string",
            "description":"Date on which the task was completed.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "ExpiryDuration":{
            "title":"Expiry Days",
            "type":"integer",
            "description":"Duration after which the task expires.",
            "format":"int32",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"5"
            }
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"4000",
            "type":"string",
            "description":"Comments for the task.",
            "nullable":true,
            "x-queryable":false
        },
        "AttachmentDocumentTypeId":{
            "title":"Document Type for Attachments",
            "type":"integer",
            "description":"Attachments to add to document records for the given document type.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ActivityAction5Label":{
            "maxLength":"120",
            "type":"string",
            "description":"Setting that enables to change the label of action 5.",
            "nullable":true,
            "x-queryable":false
        },
        "ActivityAction2Label":{
            "maxLength":"120",
            "type":"string",
            "description":"Setting that enables to change the label of action 2.",
            "nullable":true,
            "x-queryable":false
        },
        "PerformerType":{
            "title":"Performer Type",
            "type":"string",
            "description":"Task performer type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "TypeMeaning":{
            "title":"Type",
            "maxLength":"80",
            "type":"string",
            "description":"Task action type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "JourneySubCategoryMeaning":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Subcategory meaning of the worker journey.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "StatusMeaning":{
            "title":"Status",
            "maxLength":"80",
            "type":"string",
            "description":"Status of the task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "JourneyPersonNumber":{
            "title":"Person Number",
            "maxLength":"255",
            "type":"string",
            "description":"Person number of the journey assignee.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ReminderDuration":{
            "title":"Reminder Duration",
            "maxLength":"30",
            "type":"string",
            "description":"Duration of the task reminder, that's number of days between reminders.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "OwnerPersonId":{
            "title":"Owner Person ID",
            "type":"integer",
            "description":"Person identifier of the task owner. Available only in case of single owner.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "properties":{
            "title":"Properties",
            "type":"array",
            "description":"The properties resource is a child of the tasks resource. It includes display property settings for a task.",
            "items":{
                "$ref":"#/components/schemas/workerJourneyTasks-properties-item-response"
            }
        },
        "ActionCompleteLabel":{
            "maxLength":"120",
            "type":"string",
            "description":"Setting that enables to change the label of the complete action.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Candidate Attachments

Type: array

Title: Candidate Attachments

The addresses resource is the child of the recruitingUICandidates resource and provides information about the addresses of a candidate.

Show Source

• Array of: object workerJourneyTasks-attachments-item-response

{
    "title":"Candidate Attachments",
    "type":"array",
    "description":"The addresses resource is the child of the recruitingUICandidates resource and provides information about the addresses of a candidate.",
    "items":{
        "$ref":"#/components/schemas/workerJourneyTasks-attachments-item-response"
    }
}

Nested Schema : Candidate Attachments

Type: array

Title: Candidate Attachments

The addresses resource is the child of the recruitingUICandidates resource and provides information about the addresses of a candidate.

Show Source

• Array of: object workerJourneyTasks-documents-item-response

{
    "title":"Candidate Attachments",
    "type":"array",
    "description":"The addresses resource is the child of the recruitingUICandidates resource and provides information about the addresses of a candidate.",
    "items":{
        "$ref":"#/components/schemas/workerJourneyTasks-documents-item-response"
    }
}

Nested Schema : Learning Content Items List of Values

Type: array

Title: Learning Content Items List of Values

The learningContentItemsLOV resource provides a list of learning content items such as SCORM, HACP, PDF, video, assessment, and web link.

Show Source

• Array of: object workerJourneyTasks-learningItems-item-response

{
    "title":"Learning Content Items List of Values",
    "type":"array",
    "description":"The learningContentItemsLOV resource provides a list of learning content items such as SCORM, HACP, PDF, video, assessment, and web link.",
    "items":{
        "$ref":"#/components/schemas/workerJourneyTasks-learningItems-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 : Notifications

Type: array

Title: Notifications

The notifications resource is a child of the tasks resource. It includes notification settings for the task performer and owner.

Show Source

• Array of: object workerJourneyTasks-notifications-item-response

{
    "title":"Notifications",
    "type":"array",
    "description":"The notifications resource is a child of the tasks resource. It includes notification settings for the task performer and owner.",
    "items":{
        "$ref":"#/components/schemas/workerJourneyTasks-notifications-item-response"
    }
}

Nested Schema : Properties

Type: array

Title: Properties

The properties resource is a child of the tasks resource. It includes display property settings for a task.

Show Source

• Array of: object workerJourneyTasks-properties-item-response

{
    "title":"Properties",
    "type":"array",
    "description":"The properties resource is a child of the tasks resource. It includes display property settings for a task.",
    "items":{
        "$ref":"#/components/schemas/workerJourneyTasks-properties-item-response"
    }
}

Nested Schema : Questionnaire Responses

Type: array

Title: Questionnaire Responses

The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.

Show Source

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

{
    "title":"Questionnaire Responses",
    "type":"array",
    "description":"The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.",
    "items":{
        "$ref":"#/components/schemas/workerJourneyTasks-questionnaireResponses-item-response"
    }
}

Nested Schema : tasksDFF

Type: array

Show Source

• Array of: object workerJourneyTasks-tasksDFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/workerJourneyTasks-tasksDFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : workerJourneyTasks-attachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

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

  Unique identifier of the attachment. System generated primary key.
• CategoryName: string
  Title: Category

  Maximum Length: 30

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

  Indicates where the attachment is shared. If True, the attachment is shared.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

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

  Read Only: true

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

  Read Only: true

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

  Maximum Length: 30

  Default Value: FILE

  Value that indicates data type code of attachment.
• Description: string
  Title: Description

  Maximum Length: 255

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

  Unique identifier of the attachment.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Folder path of the attachment.
• DmVersionNumber: string
  Maximum Length: 255

  Version number of the attachment.
• DocumentPreviewURL: string
  Read Only: true

  Maximum Length: 255

  Attachment context.
• 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

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

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

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

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

  Maximum Length: 2048

  File name of the attachment.
• FileUrl: string
  Title: File Url

  URL of the attachment.
• 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

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

  Read Only: true

  Maximum Length: 255

  User who last updated the attachment.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

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

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

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

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

  File content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  File length of the attachment.
• UploadedFileName: string
  Title: Uploaded File Name

  File name of the attachment.
• UploadedText: string
  Title: Uploaded Text

  Text of the attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

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

  Maximum Length: 4000

  URL of the attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  User name associated with the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the attachment 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":"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":"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":"URI of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"URL of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"Unique identifier of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"Unique identifier of the attachment. System generated primary key.",
            "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":"File 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":"Name of the user who created the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"File length of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Version number of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"255",
            "type":"string",
            "description":"User who last updated the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Error status message 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":"User name associated with the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"User who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"Value that indicates data type code of attachment.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DocumentPreviewURL":{
            "maxLength":"255",
            "type":"string",
            "description":"Attachment context.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"Name of the user who last updated the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"File name of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"URL of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates where the attachment is shared. If True, 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":"Contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Expiration date and time of the attachment content.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Error status code 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":"Folder path of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"Category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date and time when the attachment was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

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

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

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

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

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

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

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

Nested Schema : properties

Type: object

Show Source

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

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

Nested Schema : workerJourneyTasks-documents-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

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

  Unique identifier of the attachment. System generated primary key.
• CategoryName: string
  Title: Category

  Maximum Length: 30

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

  Indicates where the attachment is shared. If True, the attachment is shared.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

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

  Read Only: true

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

  Read Only: true

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

  Maximum Length: 30

  Default Value: FILE

  Value that indicates data type code of attachment.
• Description: string
  Title: Description

  Maximum Length: 255

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

  Unique identifier of the attachment.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Folder path of the attachment.
• DmVersionNumber: string
  Maximum Length: 255

  Version number of the attachment.
• DocumentPreviewURL: string
  Read Only: true

  Maximum Length: 255

  Attachment context.
• 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

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

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

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

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

  Maximum Length: 2048

  File name of the attachment.
• FileUrl: string
  Title: File Url

  URL of the attachment.
• 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

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

  Read Only: true

  Maximum Length: 255

  User who last updated the attachment.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

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

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

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

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

  File content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  File length of the attachment.
• UploadedFileName: string
  Title: Uploaded File Name

  File name of the attachment.
• UploadedText: string
  Title: Uploaded Text

  Text of the attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

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

  Maximum Length: 4000

  URL of the attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  User name associated with the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the attachment 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":"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":"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":"URI of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"URL of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"Unique identifier of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"Unique identifier of the attachment. System generated primary key.",
            "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":"File 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":"Name of the user who created the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"File length of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Version number of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"255",
            "type":"string",
            "description":"User who last updated the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Error status message 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":"User name associated with the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"User who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"Value that indicates data type code of attachment.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DocumentPreviewURL":{
            "maxLength":"255",
            "type":"string",
            "description":"Attachment context.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"Name of the user who last updated the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"File name of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"URL of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates where the attachment is shared. If True, 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":"Contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Expiration date and time of the attachment content.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Error status code 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":"Folder path of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"Category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date and time when the attachment was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : workerJourneyTasks-learningItems-item-response

Type: object

Show Source

• elearnCoverArtLink: string
  Title: eLearning Cover Art Link

  Read Only: true

  URL of the content item's cover art.
• elearnDisableReassignObserverChecklistToAnyone: string
  Title: eLearning Disable Reassignment of the Observer Checklist to Anyone

  Read Only: true

  Maximum Length: 1

  Indicates whether the reassignment of the observer checklist to any user who isn't a configured observer, as defined on the learning item, is disabled. Valid values are Y, N for the observation checklist e-learn type. Default value is Y.
• elearnDisableSelfAssessChecklist: string
  Title: eLearning Disable Self-Assessment Checklist

  Read Only: true

  Maximum Length: 1

  Indicates whether the self-assessment checklist for the observation checklist is disabled. Valid values are Y, N for the observation checklist elearnType. Default value is Y.
• elearnObserverType: string
  Title: eLearning Observer Type

  Read Only: true

  Maximum Length: 30

  Type of observer for the observation checklist e-learn type such as Individuals or Representative. Valid values are defined in the list ELearnObserverTypeLOV.
• elearnObserverTypeMeaning: string
  Title: eLearning Observer Type Description

  Read Only: true

  Maximum Length: 80

  Description of the e-learn observer type.
• elearnRichMediaLink: string
  Title: eLearning Rich Media Link

  Read Only: true

  URL to open the rich media directly from the browser.
• elearnRouteUsing: string
  Title: eLearning Route Using

  Read Only: true

  Maximum Length: 30

  Approval routes for the observation checklist e-learn type. Valid values are defined in the list ELearnRouteUsingLOV.
• elearnRouteUsingMeaning: string
  Title: eLearning Route Using Description

  Read Only: true

  Maximum Length: 80

  Description of the elearnRouteUsing.
• elearnTimePERAttempt: number
  Title: eLearning Time per Attempt

  Read Only: true

  Time limit per attempt on the learning content item.
• elearnTimePERAttemptUnits: string
  Title: eLearning Time per Attempt Units

  Read Only: true

  Maximum Length: 30

  Units for time limit per attempt on the learning content item such as Hour, or Minute. Valid values are defined in the list ELearnTimePerAttemptUnitsLOV.
• elearnType: string
  Title: Content Type

  Read Only: true

  Maximum Length: 30

  Type of self-paced learning such as Video or SCORM. Valid values are defined in the list ContentTypeLOV.
• elearnTypeMeaning: string
  Title: Content Type Description

  Read Only: true

  Description of the e-learn type.
• learningItemDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 4000

  Description of the learning item.
• learningItemId: integer (int64)
  Title: Content Catalog Learning Item ID

  Read Only: true

  Unique identifier for the learning content item which is the internal primary key.
• learningItemNumber: string
  Title: Content Number

  Read Only: true

  Maximum Length: 30

  User-friendly number identifying the learning content item. It's a surrogate key which is shown in the UI.
• learningItemTitle: string
  Title: Content Title

  Read Only: true

  Maximum Length: 250

  Title of the learning content item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "elearnCoverArtLink":{
            "title":"eLearning Cover Art Link",
            "type":"string",
            "description":"URL of the content item's cover art.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "elearnDisableReassignObserverChecklistToAnyone":{
            "title":"eLearning Disable Reassignment of the Observer Checklist to Anyone",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the reassignment of the observer checklist to any user who isn't a configured observer, as defined on the learning item, is disabled. Valid values are Y, N for the observation checklist e-learn type. Default value is Y.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "elearnObserverTypeMeaning":{
            "title":"eLearning Observer Type Description",
            "maxLength":"80",
            "type":"string",
            "description":"Description of the e-learn observer type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "learningItemNumber":{
            "title":"Content Number",
            "maxLength":"30",
            "type":"string",
            "description":"User-friendly number identifying the learning content item. It's a surrogate key which is shown in the UI.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "elearnTypeMeaning":{
            "title":"Content Type Description",
            "type":"string",
            "description":"Description of the e-learn type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "elearnTimePERAttemptUnits":{
            "title":"eLearning Time per Attempt Units",
            "maxLength":"30",
            "type":"string",
            "description":"Units for time limit per attempt on the learning content item such as Hour, or Minute. Valid values are defined in the list ELearnTimePerAttemptUnitsLOV.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "learningItemTitle":{
            "title":"Content Title",
            "maxLength":"250",
            "type":"string",
            "description":"Title of the learning content item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "elearnRichMediaLink":{
            "title":"eLearning Rich Media Link",
            "type":"string",
            "description":"URL to open the rich media directly from the browser.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "elearnObserverType":{
            "title":"eLearning Observer Type",
            "maxLength":"30",
            "type":"string",
            "description":"Type of observer for the observation checklist e-learn type such as Individuals or Representative. Valid values are defined in the list ELearnObserverTypeLOV.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "elearnRouteUsingMeaning":{
            "title":"eLearning Route Using Description",
            "maxLength":"80",
            "type":"string",
            "description":"Description of the elearnRouteUsing.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "elearnType":{
            "title":"Content Type",
            "maxLength":"30",
            "type":"string",
            "description":"Type of self-paced learning such as Video or SCORM. Valid values are defined in the list ContentTypeLOV.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "elearnDisableSelfAssessChecklist":{
            "title":"eLearning Disable Self-Assessment Checklist",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the self-assessment checklist for the observation checklist is disabled. Valid values are Y, N for the observation checklist elearnType. Default value is Y.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "elearnRouteUsing":{
            "title":"eLearning Route Using",
            "maxLength":"30",
            "type":"string",
            "description":"Approval routes for the observation checklist e-learn type. Valid values are defined in the list ELearnRouteUsingLOV.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "learningItemDescription":{
            "title":"Description",
            "maxLength":"4000",
            "type":"string",
            "description":"Description of the learning item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "learningItemId":{
            "title":"Content Catalog Learning Item ID",
            "type":"integer",
            "description":"Unique identifier for the learning content item which is the internal primary key.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "elearnTimePERAttempt":{
            "title":"eLearning Time per Attempt",
            "type":"number",
            "description":"Time limit per attempt on the learning content item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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 : workerJourneyTasks-notifications-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the notification.
• CreationDate: string (date-time)
  Read Only: true

  Date on which the notification was created.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date on which the notification was updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the notification
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NotifyOwnerFlag: boolean
  Title: Notify Owner

  Maximum Length: 30

  Indicates whether the task owner needs to be notified when the event occurs. Valid values are Yes and No. The default value is No.
• NotifyPerformerFlag: boolean
  Title: Notify Performer

  Maximum Length: 30

  Indicates whether the task performer needs to be notified when the event occurs. Valid values are Yes and No. The default value is Yes.
• TaskEvent: string
  Title: Task Event Code

  Maximum Length: 30

  Code of the task event. For example, task initiated, task updated, task deleted, task completed.
• TaskEventMeaning: string
  Title: Task Event

  Read Only: true

  Maximum Length: 80

  Meaning of the task event.
• WorkerJourneyTaskNotificationId: integer (int64)
  Title: Journey Task Notification ID

  Unique identifier of the journey task notification.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who last updated the notification",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"Date on which the notification was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "WorkerJourneyTaskNotificationId":{
            "title":"Journey Task Notification ID",
            "type":"integer",
            "description":"Unique identifier of the journey task notification.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the notification.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "NotifyPerformerFlag":{
            "title":"Notify Performer",
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates whether the task performer needs to be notified when the event occurs. Valid values are Yes and No. The default value is Yes.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "TaskEventMeaning":{
            "title":"Task Event",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of the task event.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "TaskEvent":{
            "title":"Task Event Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code of the task event. For example, task initiated, task updated, task deleted, task completed.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "NotifyOwnerFlag":{
            "title":"Notify Owner",
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates whether the task owner needs to be notified when the event occurs. Valid values are Yes and No. The default value is No.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":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 on which the notification was updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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 : workerJourneyTasks-properties-item-response

Type: object

Show Source

• Category: string
  Name of the group for the journey task property.
• CategoryMeaning: string
  Meaning of the group for the journey task property.
• Code: string
  Code of the journey task property.
• DisabledForLineManagerFlag: boolean
  Indicates if the journey task property is disabled for line manager.
• DisabledForOthersFlag: boolean
  Indicates if the journey task property is disabled for other users.
• DisabledForOwnerFlag: boolean
  Indicates if the journey task property is disabled for task owner.
• DisabledForPerformerFlag: boolean
  Indicates if the journey task property is disabled for task performer.
• Level: string
  Level of the journey task property.
• LineManagerDefaultValue: string
  Default value of the journey task property for line manager.
• LineManagerLookupType: string
  Journey task property type for line manager.
• LineManagerValue: string
  Value of the journey task property for line manager.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Name of the journey task property.
• OthersDefaultValue: string
  Default value of the journey task property for other user.
• OthersLookupType: string
  Journey task property type for other user.
• OthersValue: string
  Value of the journey task property for other user.
• OverriddenFlag: boolean
  Indicates if the journey task property is overridden.
• OwnerDefaultValue: string
  Default value of the journey task property for task owner.
• OwnerLookupType: string
  Journey task property type for task owner.
• OwnerValue: string
  Value of the journey task property for task owner.
• PerformerDefaultValue: string
  Default value of the journey task property for task performer.
• PerformerLookupType: string
  Journey task property type for task performer.
• PerformerValue: string
  Value of the journey task property for task performer.
• Sequence: integer
  Display order of the property.

{
    "type":"object",
    "properties":{
        "OthersDefaultValue":{
            "type":"string",
            "description":"Default value of the journey task property for other user.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "DisabledForPerformerFlag":{
            "type":"boolean",
            "description":"Indicates if the journey task property is disabled for task performer.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Category":{
            "type":"string",
            "description":"Name of the group for the journey task property.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "OthersValue":{
            "type":"string",
            "description":"Value of the journey task property for other user.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "LineManagerValue":{
            "type":"string",
            "description":"Value of the journey task property for line manager.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Sequence":{
            "type":"integer",
            "description":"Display order of the property.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Code":{
            "type":"string",
            "description":"Code of the journey task property.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CategoryMeaning":{
            "type":"string",
            "description":"Meaning of the group for the journey task property.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Name":{
            "type":"string",
            "description":"Name of the journey task property.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "OthersLookupType":{
            "type":"string",
            "description":"Journey task property type for other user.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "DisabledForOwnerFlag":{
            "type":"boolean",
            "description":"Indicates if the journey task property is disabled for task owner.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "PerformerDefaultValue":{
            "type":"string",
            "description":"Default value of the journey task property for task performer.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "OverriddenFlag":{
            "type":"boolean",
            "description":"Indicates if the journey task property is overridden.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "PerformerValue":{
            "type":"string",
            "description":"Value of the journey task property for task performer.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "LineManagerDefaultValue":{
            "type":"string",
            "description":"Default value of the journey task property for line manager.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "DisabledForLineManagerFlag":{
            "type":"boolean",
            "description":"Indicates if the journey task property is disabled for line manager.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Level":{
            "type":"string",
            "description":"Level of the journey task property.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "PerformerLookupType":{
            "type":"string",
            "description":"Journey task property type for task performer.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "LineManagerLookupType":{
            "type":"string",
            "description":"Journey task property type for line manager.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "OwnerValue":{
            "type":"string",
            "description":"Value of the journey task property for task owner.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "OwnerLookupType":{
            "type":"string",
            "description":"Journey task property type for task owner.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "DisabledForOthersFlag":{
            "type":"boolean",
            "description":"Indicates if the journey task property is disabled for other users.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "OwnerDefaultValue":{
            "type":"string",
            "description":"Default value of the journey task property for task owner.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : workerJourneyTasks-questionnaireResponses-item-response

Type: object

Show Source

• AttemptNumber: integer (int64)
  Title: Attempt Number

  Read Only: true

  The attempt number of a participant when responding to a questionnaire.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  User who created the questionnaire response.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date on which the questionnaire response was created.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Date on which the questionnaire response was updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  User who last updated the questionnaire response.
• LatestAttemptFlag: boolean
  Title: Latest Attempt

  Read Only: true

  Maximum Length: 30

  Default Value: false

  Indicates if the response is the latest attempt by a participant to the questionnaire. This is a read-only attribute.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• QuestionnaireParticipantId: integer (int64)
  Title: Questionnaire Participant Id

  Surrogate identifier for the questionnaire participant.
• QuestionnaireResponseId: integer (int64)
  Title: Questionnaire Response Id

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

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

  The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.
• Status: string
  Title: Response Status Code

  Maximum Length: 30

  Status of the questionnaire response. I denotes the response is in progress and not submitted yet, while S denotes a submitted response.
• StatusMeaning: string
  Title: Response Status

  Read Only: true

  Maximum Length: 80

  Meaning of the status code.
• SubmittedDateTime: string (date)
  Title: Submitted Time

  Read Only: true

  Date on which the questionnaire response was submitted.
• TotalScore: number
  Title: Total Score

  Read Only: true

  Total score for the responses submitted by a participant for a questionnaire.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"User who last updated the questionnaire response.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Response Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"Status of the questionnaire response. I denotes the response is in progress and not submitted yet, while S denotes a submitted response.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date on which the questionnaire response was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AttemptNumber":{
            "title":"Attempt Number",
            "type":"integer",
            "description":"The attempt number of a participant when responding to a questionnaire.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"User who created the questionnaire response.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LatestAttemptFlag":{
            "title":"Latest Attempt",
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates if the response is the latest attempt by a participant to the questionnaire. This is a read-only attribute.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "SubmittedDateTime":{
            "title":"Submitted Time",
            "type":"string",
            "description":"Date on which the questionnaire response was submitted.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "questionResponses":{
            "title":"Question Responses",
            "type":"array",
            "description":"The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.",
            "items":{
                "$ref":"#/components/schemas/workerJourneyTasks-questionnaireResponses-questionResponses-item-response"
            }
        },
        "QuestionnaireVersionNumber":{
            "title":"Questionnaire Version",
            "type":"integer",
            "description":"Version number of the questionnaire that the participant responds to.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            }
        },
        "QuestionnaireResponseId":{
            "title":"Questionnaire Response Id",
            "type":"integer",
            "description":"Surrogate identifier for the questionnaire response.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "QuestionnaireParticipantId":{
            "title":"Questionnaire Participant Id",
            "type":"integer",
            "description":"Surrogate identifier for the questionnaire participant.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "StatusMeaning":{
            "title":"Response Status",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of the status code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TotalScore":{
            "title":"Total Score",
            "type":"number",
            "description":"Total score for the responses submitted by a participant for a questionnaire.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "scale":"2"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date on which the questionnaire response was 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 is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.

Show Source

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

{
    "title":"Question Responses",
    "type":"array",
    "description":"The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.",
    "items":{
        "$ref":"#/components/schemas/workerJourneyTasks-questionnaireResponses-questionResponses-item-response"
    }
}

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

Type: object

Show Source

• AnswerCode: string
  Title: Answer Code

  Read Only: true

  Maximum Length: 240

  The answer code that a participant chose when responding to a single choice question.
• AnswerCodeList: string
  Title: Answer Code List

  Concatenated list of answer choices, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.
• AnswerComments: string
  Title: Comments

  Maximum Length: 4000

  Additional comments provided by the participant when responding to a question.
• AnswerLargeObject: string (byte)
  Title: Answer

  Attachment provided by the participant when responding to a question.
• AnswerList: string
  Title: Answer List

  Maximum Length: 2000

  Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.
• AnswerShortdescription: string
  Title: Answer Short Description

  Read Only: true

  Maximum Length: 240

  Text of the answer chosen by a participant when responding to a single choice question.
• AnswerShortDescriptionList: string
  Title: Answer Short Description

  Read Only: true

  Concatenated list of answer texts, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.
• ChoiceCodeList: string
  Title: Choice List Code

  Concatenated list of answer codes, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.
• ChoiceList: string
  Title: Choice List

  Maximum Length: 2000

  Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.
• ChoiceShortDescription: string
  Title: Choice Short Description

  Read Only: true

  Concatenated list of answer texts, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  User who created the question response.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date on which the question response was created.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Date on which the question response was updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  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

  Maximum Length: 240

  Alphanumeric value that uniquely identifies a question defined for a subscriber.
• QuestionId: integer (int64)
  Title: Question Id

  Surrogate identifier for the question.
• QuestionnaireQuestionId: integer (int64)
  Title: Questionnaire Question Id

  Surrogate identifier for the question in a questionnaire.
• questionResponseAttachments: array Question Response Attachments
  Title: Question Response Attachments

  The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
• QuestionResponseId: integer (int64)
  Title: Question Response Id

  Surrogate identifier for the question response.
• QuestionText: string
  Title: Question Text

  Read Only: true

  Maximum Length: 2000

  Text of the question that a participant responds to.
• Score: integer (int64)
  Title: Answer Score

  Read Only: true

  Calculated score for the responses provided for a question by a participant.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"User who last updated the question response.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date on which the question response was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AnswerList":{
            "title":"Answer List",
            "maxLength":"2000",
            "type":"string",
            "description":"Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"User who created the question response.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "questionResponseAttachments":{
            "title":"Question Response Attachments",
            "type":"array",
            "description":"The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.",
            "items":{
                "$ref":"#/components/schemas/workerJourneyTasks-questionnaireResponses-questionResponses-questionResponseAttachments-item-response"
            }
        },
        "ChoiceList":{
            "title":"Choice List",
            "maxLength":"2000",
            "type":"string",
            "description":"Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.",
            "nullable":true,
            "x-queryable":false
        },
        "QuestionResponseId":{
            "title":"Question Response Id",
            "type":"integer",
            "description":"Surrogate identifier for the question response.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "AnswerComments":{
            "title":"Comments",
            "maxLength":"4000",
            "type":"string",
            "description":"Additional comments provided by the participant when responding to a question.",
            "nullable":true,
            "x-queryable":true
        },
        "AnswerShortDescriptionList":{
            "title":"Answer Short Description",
            "type":"string",
            "description":"Concatenated list of answer texts, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AnswerCodeList":{
            "title":"Answer Code List",
            "type":"string",
            "description":"Concatenated list of answer choices, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.",
            "nullable":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":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "AnswerCode":{
            "title":"Answer Code",
            "maxLength":"240",
            "type":"string",
            "description":"The answer code that a participant chose when responding to a single choice question.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "QuestionnaireQuestionId"
                ]
            },
            "x-queryable":true
        },
        "ChoiceShortDescription":{
            "title":"Choice Short Description",
            "type":"string",
            "description":"Concatenated list of answer texts, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Score":{
            "title":"Answer Score",
            "type":"integer",
            "description":"Calculated score for the responses provided for a question by a participant.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            }
        },
        "QuestionCode":{
            "title":"Question Code",
            "maxLength":"240",
            "type":"string",
            "description":"Alphanumeric value that uniquely identifies a question defined for a subscriber.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "AnswerShortdescription":{
            "title":"Answer Short Description",
            "maxLength":"240",
            "type":"string",
            "description":"Text of the answer chosen by a participant when responding to a single choice question.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "QuestionId":{
            "title":"Question Id",
            "type":"integer",
            "description":"Surrogate identifier for the question.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "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":{
                "includeInCompactView":true,
                "precision":"18",
                "dependencies":[
                    "QuestionCode",
                    "QuestionId"
                ]
            },
            "x-queryable":true
        },
        "AnswerLargeObject":{
            "title":"Answer",
            "type":"string",
            "description":"Attachment provided by the participant when responding to a question.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ChoiceCodeList":{
            "title":"Choice List Code",
            "type":"string",
            "description":"Concatenated list of answer codes, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "QuestionText":{
            "title":"Question Text",
            "maxLength":"2000",
            "type":"string",
            "description":"Text of the question that a participant responds to.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date on which the question response was 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 Response Attachments

Type: array

Title: Question Response Attachments

The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.

Show Source

• Array of: object workerJourneyTasks-questionnaireResponses-questionResponses-questionResponseAttachments-item-response

{
    "title":"Question Response Attachments",
    "type":"array",
    "description":"The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.",
    "items":{
        "$ref":"#/components/schemas/workerJourneyTasks-questionnaireResponses-questionResponses-questionResponseAttachments-item-response"
    }
}

Nested Schema : workerJourneyTasks-questionnaireResponses-questionResponses-questionResponseAttachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

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

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

  Maximum Length: 30

  Category name of the attachment. This is a read-only attribute.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the file can be shared. The default value is false and it's the only supported value.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

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

  Read Only: true

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

  Read Only: true

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

  Maximum Length: 30

  Default Value: FILE

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

  Maximum Length: 255

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

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

  Maximum Length: 1000

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

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

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

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

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

  Expiration date of the attachment. This is a read-only attribute.
• FileContents: string (byte)
  Title: File Contents

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

  Maximum Length: 2048

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

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

  Read Only: true

  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

  Date on which the attachment was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  User who last updated the attachment.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  Name of the user who last updated the attachment 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

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

  Content type of the uploaded file. This is a read-only attribute.
• UploadedFileLength: integer
  Title: File Size

  Size of the uploaded file. This is a read-only attribute.
• UploadedFileName: string
  Title: Uploaded File Name

  Name of the uploaded file. This is a read-only attribute.
• UploadedText: string
  Title: Uploaded Text

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

  Maximum Length: 4000

  URI of the attachment. This is a read-only attribute.
• Url: string
  Title: Url

  Maximum Length: 4000

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

  Read Only: true

  Maximum Length: 255

  User name of the person who uploaded the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date on which the attachment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"Description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"Name of the attachment file.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"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":"URI of the attachment. This is a read-only attribute.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"URL of a web page attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"Surrogate identifier of the document attached to the questionnaire.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"Unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Content type of the uploaded file. This is a read-only attribute.",
            "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":"User name of the user who created the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Size of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Version number of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"255",
            "type":"string",
            "description":"User who last updated the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Error status message of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":"255",
            "type":"string",
            "description":"User name of the person who uploaded the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"User who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"Attachment type supported for the question. Only the attachment type, FILE, is supported.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"Name of the user who last updated the attachment 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":"Name of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"File URL of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the file can be shared. The default value is false and it's the only supported value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"File contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Expiration date of the attachment. This is a read-only attribute.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Error status code of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"Path of the folder.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text uploaded in the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"Category name of the attachment. This is a read-only attribute.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date on which the attachment 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 exclusively for the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : workerJourneyTasks-tasksDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30
• __FLEX_Context_DisplayValue: string
  Title: Context Value
• AllocatedTaskId: integer (int64)
  Title: Allocated Task Identifier
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AllocatedTaskId":{
            "title":"Allocated Task Identifier",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":"30",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "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"
    }
}

Links

attachments

Operation: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/attachments

Parameters:

• workerJourneyTasksUniqID: $request.path.workerJourneyTasksUniqID

The addresses resource is the child of the recruitingUICandidates resource and provides information about the addresses of a candidate.

checkTaskCompletion

Operation: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/action/checkTaskCompletion

Parameters:

• workerJourneyTasksUniqID: $request.path.workerJourneyTasksUniqID

Checks if the task can be completed.

copyToDocumentRecords

Operation: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/action/copyToDocumentRecords

Parameters:

• workerJourneyTasksUniqID: $request.path.workerJourneyTasksUniqID

Uploads the document to document records.

documents

Operation: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/documents

Parameters:

• workerJourneyTasksUniqID: $request.path.workerJourneyTasksUniqID

The addresses resource is the child of the recruitingUICandidates resource and provides information about the addresses of a candidate.

generateContent

Operation: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/action/generateContent

Parameters:

• workerJourneyTasksUniqID: $request.path.workerJourneyTasksUniqID

Generates user-defined content of a task.

generateNavigationDetails

Operation: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/action/generateNavigationDetails

Parameters:

• workerJourneyTasksUniqID: $request.path.workerJourneyTasksUniqID

Navigates to the application task where the performer can perform the task.

generateNavigationURL

Operation: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/action/generateNavigationURL

Parameters:

• workerJourneyTasksUniqID: $request.path.workerJourneyTasksUniqID

Navigates to the URL where the performer can perform the task.

invokeProcessAutomation

Operation: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/action/invokeProcessAutomation

Parameters:

• workerJourneyTasksUniqID: $request.path.workerJourneyTasksUniqID

Initiates the process automation integration.

learningItems

Operation: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/learningItems

Parameters:

• workerJourneyTasksUniqID: $request.path.workerJourneyTasksUniqID

The learningContentItemsLOV resource provides a list of learning content items such as SCORM, HACP, PDF, video, assessment, and web link.

notifications

Operation: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/notifications

Parameters:

• workerJourneyTasksUniqID: $request.path.workerJourneyTasksUniqID

The notifications resource is a child of the tasks resource. It includes notification settings for the task performer and owner.

properties

Operation: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/properties

Parameters:

• workerJourneyTasksUniqID: $request.path.workerJourneyTasksUniqID

The properties resource is a child of the tasks resource. It includes display property settings for a task.

questionnaireResponses

Operation: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/questionnaireResponses

Parameters:

• workerJourneyTasksUniqID: $request.path.workerJourneyTasksUniqID

The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.

reassign

Operation: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/action/reassign

Parameters:

• workerJourneyTasksUniqID: $request.path.workerJourneyTasksUniqID

Reassigns a task to another task performer.

reminderRelativeToLov

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_PER_CHK_TASK_REMINDER_TIME

The following properties are defined on the LOV link relation:

• Source Attribute: ReminderRelativeTo; Target Attribute: LookupCode
• Display Attribute: Meaning

sendReminder

Operation: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/action/sendReminder

Parameters:

• workerJourneyTasksUniqID: $request.path.workerJourneyTasksUniqID

Sends a reminder to the task performer.

taskStatusLov

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DPER_CHECKLIST_TASK_STATUS

The following properties are defined on the LOV link relation:

• Source Attribute: Status; Target Attribute: LookupCode
• Display Attribute: Meaning

tasksDFF

Operation: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/tasksDFF

Parameters:

• workerJourneyTasksUniqID: $request.path.workerJourneyTasksUniqID

Back to Top