Jump to

• Request
• Response

Get a worker journey

get

/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}

Request

Path Parameters

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

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

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

There's no request body for this operation.

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

Type: object

Show Source

• AccessBasicInformation: string
  Title: Access Basic Info

  Read Only: true

  Setting that determines if the signed in user can access the Basic Info section.
• AccessCompletedTasks: string
  Title: Access Completed Tasks

  Read Only: true

  Setting that determines if the signed in user can access the Completed Tasks section.
• AccessContactSection: string
  Read Only: true

  Setting that determines if the signed in user can view the Contact Us section.
• AccessDeferredTasks: string
  Title: Access Deferred Tasks

  Read Only: true

  Setting that determines if the signed in user can access the Deferred Tasks section.
• AccessEvents: string
  Title: Access What's Happening

  Read Only: true

  Setting that determines if the signed in user can access the What's Happening section.
• AccessNotes: string
  Title: Access Notes

  Read Only: true

  Setting that determines if the signed in user can access the Notes section.
• AccessOthersTasks: string
  Title: Access Others Tasks

  Read Only: true

  Setting that determines if the signed in user can access the Others' Tasks section.
• ActionAddTask: string
  Title: Add a Task

  Read Only: true

  Setting that determines if the signed in user can add a task to the journey.
• ActionAddTaskFromLibrary: string
  Title: Add a Task from Task Library

  Read Only: true

  Setting that determines if the signed in user can add a task from the task library for the journey.
• ActionDate: string (date)
  Title: Action Date

  Date as of which the journey is allocated.
• ActionEdit: string
  Title: Edit

  Read Only: true

  Setting that determines if the signed in user can edit the worker journey.
• ActionForceClose: string
  Title: Force Close

  Read Only: true

  Setting that determines if the signed in user can force close the journey.
• ActionOccurrenceId: integer (int64)
  Title: Action Occurrence ID

  Read Only: true

  Unique identifier of the employment action for which this journey is assigned.
• ActionRemove: string
  Title: Remove

  Read Only: true

  Setting that determines if the signed in user can remove the journey.
• AllocationDate: string (date)
  Title: Allocation Date

  Date on which the journey is initiated.
• AllowSaveAsTemplateFlag: boolean
  Indicates whether the journey can be saved as a template.
• allStepTasks: array All Step Tasks
  Title: All Step Tasks

  The allStepTasks resource is a child of the workerJourneys resource. It includes all the step tasks in the worker journey.
• ArchiveOffsetDays: integer (int32)
  Title: Archive After Months

  Duration after which the completed assigned journeys will be archived.
• AssignedDate: string (date)
  Title: Assigned Date

  Date on which the journey record was created.
• AssignedDateForSort: string (date)
  Read Only: true

  Date by which journeys can be sorted.
• AssignedFeedFlag: boolean
  Indicates whether the atom feed is enabled when a journey is assigned.
• AssignmentId: integer (int64)
  Internal identifier of the journey assignee's assignment.
• AssignmentName: string
  Title: Business Title

  Read Only: true

  Maximum Length: 255

  Business title of the journey assignee.
• BackgroundImageSource: string
  Read Only: true

  Source of the background image.
• BackgroundImageURL: string
  Title: Background Image URL

  Read Only: true

  Maximum Length: 4000

  URL of the image displayed on the journey card and journey details page.
• BackgroundThumbnailURL: string
  Title: Thumbnail Image URL

  Read Only: true

  Maximum Length: 4000

  URL of the journey background thumbnail image.
• Category: string
  Title: Category Code

  Maximum Length: 60

  Category code of the journey.
• CategoryMeaning: string
  Title: Category

  Read Only: true

  Maximum Length: 80

  Meaning of the journey category.
• Comments: string
  Title: Comments

  Maximum Length: 4000

  Comments for the journey.
• CompletedFeedFlag: boolean
  Indicates whether the atom feed is enabled when a journey is completed.
• CompletionCriteria: string
  Title: Completion Criteria

  Maximum Length: 30

  Criteria to complete an assigned journey.
• CompletionCriteriaMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Meaning of the completion criteria.
• CompletionDate: string (date)
  Title: Completion Date

  Read Only: true

  Date on which the journey is completed.
• CompletionMessage: string
  Read Only: true

  Maximum Length: 720

  Message displayed when the journey is completed.
• CompletionOffsetDays: integer (int32)
  Title: Days for Completion

  Number of days after which the journey should be marked as complete.
• contacts: array Contacts
  Title: Contacts

  The contacts resource is a child of the workerJourneys resource. It includes a list of contacts associated with the worker journey.
• Context: string
  Maximum Length: 240

  Context for a journey.
• ContextualAction: string
  Read Only: true

  Maximum Length: 240

  Transaction flow for which the contextual journey is applicable.
• Country: string
  Title: Country

  Read Only: true

  Maximum Length: 80

  Name of the country to which the journey is applicable.
• CountryCode: string
  Title: Legislation Code

  Maximum Length: 30

  Code of the country to which the journey is applicable.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date on which the task was created.
• DeletedFeedFlag: boolean
  Indicates whether the atom feed is enabled when a journey is deleted.
• Description: string
  Title: Description

  Maximum Length: 360

  Description of the journey.
• DisplayName: string
  Title: Person Name

  Read Only: true

  Maximum Length: 240

  Display name of the journey assignee
• events: array Events
  Title: Events

  The events resource is a child of the workerJourneys resource. It includes a list of events associated with the worker journey.
• FeedFlag: boolean
  Indicates whether the atom feed is enabled.
• InitiatedFeedFlag: boolean
  Indicates whether the atom feed is enabled when a journey is initiated.
• InitiatorDisplayName: string
  Read Only: true

  Maximum Length: 240

  Display name of the journey initiator.
• InitiatorPersonId: integer (int64)
  Title: Initiator Person Identifier

  Read Only: true

  Internal identifier of the journey initiator.
• Instance: string
  Title: Instance

  Maximum Length: 20

  Instance of the allocated journey to identify if the same journey is allocated to the worker multiple times.
• JourneyDisplayName: string
  Title: Journey Display Name

  Display name of the journey.
• JourneyId: integer (int64)
  Title: Template Identifier

  Read Only: true

  Identifier of the journey.
• JourneyTitle: string
  Title: Journey Title

  Read Only: true

  Title of the journey that's displayed on the specific journey's landing page.
• 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.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MessageSubTitle: string
  Read Only: true

  Maximum Length: 720

  Subtitle of the message displayed in the journey details.
• MessageText: string
  Title: Message Text

  Read Only: true

  Maximum Length: 400

  Message text displayed for the journey.
• MessageTitle: string
  Title: Message Title

  Maximum Length: 400

  Title for the message displayed in the journey details.
• Name: string
  Title: Name

  Maximum Length: 240

  Name of the journey.
• notes: array Notes
  Title: Notes

  The notes resource is a child of the workerJourneys resource. It includes the notes associated with the worker journey.
• ObjectId: integer (int64)
  Title: Object ID

  Read Only: true

  Default Value: -1

  Unique identifier of the event object for which this journey is assigned.
• ObjectReferenceId: integer (int64)
  Read Only: true

  Reference identifier of the journey template object.
• PersonId: integer (int64)
  Title: Person ID

  Internal identifier of the journey assignee.
• PersonNumber: string
  Title: Person Number

  Read Only: true

  Maximum Length: 255

  Number assigned to the journey assignee to identify the person uniquely.
• properties: array Journey Task Properties
  Title: Journey Task Properties

  The properties resource is the child of the workerJourneys resource. It includes all the journey properties associated with the parent journey template.
• PurgeOffsetDays: integer (int32)
  Title: Purge After Months

  The duration after which all archived journeys will be purged.
• Status: string
  Title: Status Code

  Maximum Length: 60

  Status code of the worker journey.
• StatusMeaning: string
  Title: Status

  Read Only: true

  Maximum Length: 80

  Status of the worker journey.
• SubCategory: string
  Read Only: true

  Maximum Length: 60

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

  Read Only: true

  Maximum Length: 80

  Subcategory meaning of the worker journey.
• taskCounts: array Task Counts
  Title: Task Counts

  The taskCounts resource is a child of the workerJourneys resource. It includes a summary of the tasks in the worker journey.
• tasks: array Tasks
  Title: Tasks

  The tasks resource is a child of the workerJourneys resource. It includes all the tasks in the worker journey.
• taskTypes: array Task Types
  Title: Task Types

  The taskTypes resource is the child of the workerJourneys resource. It includes all the task types associated with the parent journey template.
• WorkerJourneyId: integer (int64)
  Title: Worker Journey ID

  Read Only: true

  Primary key generated by the application.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date on which the task was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "notes":{
            "title":"Notes",
            "type":"array",
            "description":"The notes resource is a child of the workerJourneys resource. It includes the notes associated with the worker journey.",
            "items":{
                "$ref":"#/components/schemas/workerJourneys-notes-item-response"
            }
        },
        "AccessContactSection":{
            "type":"string",
            "description":"Setting that determines if the signed in user can view the Contact Us section.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CompletionCriteria":{
            "title":"Completion Criteria",
            "maxLength":"30",
            "type":"string",
            "description":"Criteria to complete an assigned journey.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ActionDate":{
            "title":"Action Date",
            "type":"string",
            "description":"Date as of which the journey is allocated.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the journey.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "JourneyDisplayName":{
            "title":"Journey Display Name",
            "type":"string",
            "description":"Display name of the journey.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "dependencies":[
                    "Instance",
                    "Name",
                    "ChecklistDisplayName"
                ]
            }
        },
        "AccessBasicInformation":{
            "title":"Access Basic Info",
            "type":"string",
            "description":"Setting that determines if the signed in user can access the Basic Info section.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CompletionCriteriaMeaning":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of the completion criteria.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "taskCounts":{
            "title":"Task Counts",
            "type":"array",
            "description":"The taskCounts resource is a child of the workerJourneys resource. It includes a summary of the tasks in the worker journey.",
            "items":{
                "$ref":"#/components/schemas/workerJourneys-taskCounts-item-response"
            },
            "x-cardinality":"1"
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CompletionOffsetDays":{
            "title":"Days for Completion",
            "type":"integer",
            "description":"Number of days after which the journey should be marked as complete.",
            "format":"int32",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"5"
            }
        },
        "AllowSaveAsTemplateFlag":{
            "type":"boolean",
            "description":"Indicates whether the journey can be saved as a template.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "DeletedFeedFlag":{
            "type":"boolean",
            "description":"Indicates whether the atom feed is enabled when a journey is deleted.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "events":{
            "title":"Events",
            "type":"array",
            "description":"The events resource is a child of the workerJourneys resource. It includes a list of events associated with the worker journey.",
            "items":{
                "$ref":"#/components/schemas/workerJourneys-events-item-response"
            }
        },
        "tasks":{
            "title":"Tasks",
            "type":"array",
            "description":"The tasks resource is a child of the workerJourneys resource. It includes all the tasks in the worker journey.",
            "items":{
                "$ref":"#/components/schemas/workerJourneys-tasks-item-response"
            }
        },
        "ArchiveOffsetDays":{
            "title":"Archive After Months",
            "type":"integer",
            "description":"Duration after which the completed assigned journeys will be archived.",
            "format":"int32",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"5"
            }
        },
        "PurgeOffsetDays":{
            "title":"Purge After Months",
            "type":"integer",
            "description":"The duration after which all archived journeys will be purged.",
            "format":"int32",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"5"
            }
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who last updated the task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "InitiatorPersonId":{
            "title":"Initiator Person Identifier",
            "type":"integer",
            "description":"Internal identifier of the journey initiator.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "Status":{
            "title":"Status Code",
            "maxLength":"60",
            "type":"string",
            "description":"Status code of the worker journey.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "BackgroundImageURL":{
            "title":"Background Image URL",
            "maxLength":"4000",
            "type":"string",
            "description":"URL of the image displayed on the journey card and journey details page.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "FeedFlag":{
            "type":"boolean",
            "description":"Indicates whether the atom feed is enabled.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ActionEdit":{
            "title":"Edit",
            "type":"string",
            "description":"Setting that determines if the signed in user can edit the worker journey.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CategoryMeaning":{
            "title":"Category",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of the journey category.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "JourneyId":{
            "title":"Template Identifier",
            "type":"integer",
            "description":"Identifier of the journey.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "MessageTitle":{
            "title":"Message Title",
            "maxLength":"400",
            "type":"string",
            "description":"Title for the message displayed in the journey details.",
            "nullable":true,
            "x-queryable":false
        },
        "PersonId":{
            "title":"Person ID",
            "type":"integer",
            "description":"Internal identifier of the journey assignee.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssignmentName":{
            "title":"Business Title",
            "maxLength":"255",
            "type":"string",
            "description":"Business title of the journey assignee.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ActionAddTaskFromLibrary":{
            "title":"Add a Task from Task Library",
            "type":"string",
            "description":"Setting that determines if the signed in user can add a task from the task library for the journey.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Country":{
            "title":"Country",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the country to which the journey is applicable.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CompletionMessage":{
            "maxLength":"720",
            "type":"string",
            "description":"Message displayed when the journey is completed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "allStepTasks":{
            "title":"All Step Tasks",
            "type":"array",
            "description":"The allStepTasks resource is a child of the workerJourneys resource. It includes all the step tasks in the worker journey.",
            "items":{
                "$ref":"#/components/schemas/workerJourneys-allStepTasks-item-response"
            }
        },
        "BackgroundImageSource":{
            "type":"string",
            "description":"Source of the background image.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "BackgroundImageURL"
                ]
            }
        },
        "Category":{
            "title":"Category Code",
            "maxLength":"60",
            "type":"string",
            "description":"Category code of the journey.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"360",
            "type":"string",
            "description":"Description of the journey.",
            "nullable":true,
            "x-queryable":false
        },
        "Instance":{
            "title":"Instance",
            "maxLength":"20",
            "type":"string",
            "description":"Instance of the allocated journey to identify if the same journey is allocated to the worker multiple times.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SubCategoryMeaning":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Subcategory meaning of the worker journey.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CompletedFeedFlag":{
            "type":"boolean",
            "description":"Indicates whether the atom feed is enabled when a journey is completed.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "BackgroundThumbnailURL":{
            "title":"Thumbnail Image URL",
            "maxLength":"4000",
            "type":"string",
            "description":"URL of the journey background thumbnail image.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AccessEvents":{
            "title":"Access What's Happening",
            "type":"string",
            "description":"Setting that determines if the signed in user can access the What's Happening section.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "WorkerJourneyId":{
            "title":"Worker Journey ID",
            "type":"integer",
            "description":"Primary key generated by the application.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssignedDate":{
            "title":"Assigned Date",
            "type":"string",
            "description":"Date on which the journey record was created.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "DisplayName":{
            "title":"Person Name",
            "maxLength":"240",
            "type":"string",
            "description":"Display name of the journey assignee",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AssignmentId":{
            "type":"integer",
            "description":"Internal identifier of the journey assignee's assignment.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "AllocationDate":{
            "title":"Allocation Date",
            "type":"string",
            "description":"Date on which the journey is initiated.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "AccessOthersTasks":{
            "title":"Access Others Tasks",
            "type":"string",
            "description":"Setting that determines if the signed in user can access the Others' Tasks section.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "taskTypes":{
            "title":"Task Types",
            "type":"array",
            "description":"The taskTypes resource is the child of the workerJourneys resource. It includes all the task types associated with the parent journey template.",
            "items":{
                "$ref":"#/components/schemas/workerJourneys-taskTypes-item-response"
            }
        },
        "MessageSubTitle":{
            "maxLength":"720",
            "type":"string",
            "description":"Subtitle of the message displayed in the journey details.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ContextualAction":{
            "maxLength":"240",
            "type":"string",
            "description":"Transaction flow for which the contextual journey is applicable.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CountryCode":{
            "title":"Legislation Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code of the country to which the journey is applicable.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CompletionDate":{
            "title":"Completion Date",
            "type":"string",
            "description":"Date on which the journey is completed.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ActionOccurrenceId":{
            "title":"Action Occurrence ID",
            "type":"integer",
            "description":"Unique identifier of the employment action for which this journey is assigned.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ObjectReferenceId":{
            "type":"integer",
            "description":"Reference identifier of the journey template object.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ActionRemove":{
            "title":"Remove",
            "type":"string",
            "description":"Setting that determines if the signed in user can remove the journey.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PersonNumber":{
            "title":"Person Number",
            "maxLength":"255",
            "type":"string",
            "description":"Number assigned to the journey assignee to identify the person uniquely.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Context":{
            "maxLength":"240",
            "type":"string",
            "description":"Context for a journey.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectId":{
            "title":"Object ID",
            "type":"integer",
            "description":"Unique identifier of the event object for which this journey is assigned.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "default":"-1",
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"4000",
            "type":"string",
            "description":"Comments for the journey.",
            "nullable":true,
            "x-queryable":false
        },
        "AssignedFeedFlag":{
            "type":"boolean",
            "description":"Indicates whether the atom feed is enabled when a journey is assigned.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "MessageText":{
            "title":"Message Text",
            "maxLength":"400",
            "type":"string",
            "description":"Message text displayed for the journey.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AccessDeferredTasks":{
            "title":"Access Deferred Tasks",
            "type":"string",
            "description":"Setting that determines if the signed in user can access the Deferred Tasks section.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StatusMeaning":{
            "title":"Status",
            "maxLength":"80",
            "type":"string",
            "description":"Status of the worker journey.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "AccessNotes":{
            "title":"Access Notes",
            "type":"string",
            "description":"Setting that determines if the signed in user can access the Notes section.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "JourneyTitle":{
            "title":"Journey Title",
            "type":"string",
            "description":"Title of the journey that's displayed on the specific journey's landing page.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "Category",
                    "JourneyDisplayName",
                    "MessageText"
                ]
            }
        },
        "ActionAddTask":{
            "title":"Add a Task",
            "type":"string",
            "description":"Setting that determines if the signed in user can add a task to the journey.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "InitiatedFeedFlag":{
            "type":"boolean",
            "description":"Indicates whether the atom feed is enabled when a journey is initiated.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "SubCategory":{
            "maxLength":"60",
            "type":"string",
            "description":"Subcategory of the worker journey.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedDateForSort":{
            "type":"string",
            "description":"Date by which journeys can be sorted.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ActionForceClose":{
            "title":"Force Close",
            "type":"string",
            "description":"Setting that determines if the signed in user can force close the journey.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "InitiatorDisplayName":{
            "maxLength":"240",
            "type":"string",
            "description":"Display name of the journey initiator.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccessCompletedTasks":{
            "title":"Access Completed Tasks",
            "type":"string",
            "description":"Setting that determines if the signed in user can access the Completed Tasks section.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "contacts":{
            "title":"Contacts",
            "type":"array",
            "description":"The contacts resource is a child of the workerJourneys resource. It includes a list of contacts associated with the worker journey.",
            "items":{
                "$ref":"#/components/schemas/workerJourneys-contacts-item-response"
            }
        },
        "properties":{
            "title":"Journey Task Properties",
            "type":"array",
            "description":"The properties resource is the child of the workerJourneys resource. It includes all the journey properties associated with the parent journey template.",
            "items":{
                "$ref":"#/components/schemas/workerJourneys-properties-item-response"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date on which the task was updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

Nested Schema : All Step Tasks

Type: array

Title: All Step Tasks

The allStepTasks resource is a child of the workerJourneys resource. It includes all the step tasks in the worker journey.

Show Source

• Array of: object workerJourneys-allStepTasks-item-response

{
    "title":"All Step Tasks",
    "type":"array",
    "description":"The allStepTasks resource is a child of the workerJourneys resource. It includes all the step tasks in the worker journey.",
    "items":{
        "$ref":"#/components/schemas/workerJourneys-allStepTasks-item-response"
    }
}

Nested Schema : Contacts

Type: array

Title: Contacts

The contacts resource is a child of the workerJourneys resource. It includes a list of contacts associated with the worker journey.

Show Source

• Array of: object workerJourneys-contacts-item-response

{
    "title":"Contacts",
    "type":"array",
    "description":"The contacts resource is a child of the workerJourneys resource. It includes a list of contacts associated with the worker journey.",
    "items":{
        "$ref":"#/components/schemas/workerJourneys-contacts-item-response"
    }
}

Nested Schema : Events

Type: array

Title: Events

The events resource is a child of the workerJourneys resource. It includes a list of events associated with the worker journey.

Show Source

• Array of: object workerJourneys-events-item-response

{
    "title":"Events",
    "type":"array",
    "description":"The events resource is a child of the workerJourneys resource. It includes a list of events associated with the worker journey.",
    "items":{
        "$ref":"#/components/schemas/workerJourneys-events-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 : Notes

Type: array

Title: Notes

The notes resource is a child of the workerJourneys resource. It includes the notes associated with the worker journey.

Show Source

• Array of: object workerJourneys-notes-item-response

{
    "title":"Notes",
    "type":"array",
    "description":"The notes resource is a child of the workerJourneys resource. It includes the notes associated with the worker journey.",
    "items":{
        "$ref":"#/components/schemas/workerJourneys-notes-item-response"
    }
}

Nested Schema : Journey Task Properties

Type: array

Title: Journey Task Properties

The properties resource is the child of the workerJourneys resource. It includes all the journey properties associated with the parent journey template.

Show Source

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

{
    "title":"Journey Task Properties",
    "type":"array",
    "description":"The properties resource is the child of the workerJourneys resource. It includes all the journey properties associated with the parent journey template.",
    "items":{
        "$ref":"#/components/schemas/workerJourneys-properties-item-response"
    }
}

Nested Schema : Task Counts

Type: array

Title: Task Counts

The taskCounts resource is a child of the workerJourneys resource. It includes a summary of the tasks in the worker journey.

Show Source

• Array of: object workerJourneys-taskCounts-item-response

{
    "title":"Task Counts",
    "type":"array",
    "description":"The taskCounts resource is a child of the workerJourneys resource. It includes a summary of the tasks in the worker journey.",
    "items":{
        "$ref":"#/components/schemas/workerJourneys-taskCounts-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Tasks

Type: array

Title: Tasks

The tasks resource is a child of the workerJourneys resource. It includes all the tasks in the worker journey.

Show Source

• Array of: object workerJourneys-tasks-item-response

{
    "title":"Tasks",
    "type":"array",
    "description":"The tasks resource is a child of the workerJourneys resource. It includes all the tasks in the worker journey.",
    "items":{
        "$ref":"#/components/schemas/workerJourneys-tasks-item-response"
    }
}

Nested Schema : Task Types

Type: array

Title: Task Types

The taskTypes resource is the child of the workerJourneys resource. It includes all the task types associated with the parent journey template.

Show Source

• Array of: object workerJourneys-taskTypes-item-response

{
    "title":"Task Types",
    "type":"array",
    "description":"The taskTypes resource is the child of the workerJourneys resource. It includes all the task types associated with the parent journey template.",
    "items":{
        "$ref":"#/components/schemas/workerJourneys-taskTypes-item-response"
    }
}

Nested Schema : workerJourneys-allStepTasks-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.
• ActionComplete: string
  Title: Mark as Complete

  Read Only: true

  Setting that determines if the signed in user can mark the task as complete.
• 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.
• 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.
• ActionSendReminder: string
  Title: Send Reminder

  Read Only: true

  Setting that determines if the signed in user can send a reminder for a task.
• ActionURL: string
  Title: URL

  Read Only: true

  Maximum Length: 1000

  URL associated with the task that's entered on the setup screen.
• ActualEndDate: string (date)
  Title: Actual End Date

  Read Only: true

  End date of the task.
• ActualStartDate: string (date)
  Title: Actual Start Date

  Read Only: true

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

  Read Only: true

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

  Read Only: true

  Indicates whether comments are enabled for a task. Valid values are Yes and No. The default value is No.
• AllowNotesContentFlag: boolean
  Read Only: true

  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.
• ApplicationTaskName: string
  Title: Application Task

  Read Only: true

  Display name of the application task.
• Comments: string
  Title: Comments

  Read Only: true

  Maximum Length: 4000

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

  Read Only: true

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

  Descriptive flexfield context code for configurable form task type.
• ContentProviderCode: string
  Read Only: true

  Maximum Length: 240

  Code of the user-defined content task.
• DeferredStartDate: string (date)
  Title: Deferred Task Start Date

  Read Only: true

  Start date for the deferred task.
• DependentTaskId: integer (int64)
  Title: Preceding Task ID

  Read Only: true

  Primary key or 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

  Read Only: true

  Maximum Length: 4000

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

  Maximum Length: 240

  Code of the embedded application task.
• links: array Links
  Title: Links

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

  Read Only: true

  Maximum Length: 240

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

  Read Only: true

  Notes for the 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.
• 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 existing page or a new page. Valid values are Yes and No. The default value is Yes.
• OwnerName: string
  Title: Owner Name

  Read Only: true

  Person display name of task owner in case of single owner. Else, returns responsibility type name.
• OwnerPersonId: integer (int64)
  Title: Owner Person ID

  Read Only: true

  Identifier of the task owner. Applicable only in case of a single task 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.
• ParentWorkerJourneyId: integer (int64)
  Title: Worker Journey ID

  Read Only: true

  Unique identifier of the parent enterprise onboarding checklist.
• PerformerName: string
  Title: Performer Name

  Read Only: true

  Person display name of task performer in case of single performer. Else, returns responsibility type name.
• PerformerPersonId: integer (int64)
  Title: Performer Person ID

  Read Only: true

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

  Read Only: true

  Task performer type.
• PerformerTypeMeaning: string
  Title: Performer

  Read Only: true

  Task performer type meaning.
• ReportPath: string
  Title: Report Path

  Read Only: true

  Maximum Length: 1000

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

  Read Only: true

  Maximum Length: 30

  Indicates whether the task is mandatory or optional. Valid values are Yes and No. The default value is No.
• Sequence: integer (int32)
  Title: Sequence

  Read Only: true

  Task display ordering sequence. Default is 1.
• SignAddress: string
  Title: IP Address of Signature

  Read Only: true

  Maximum Length: 120

  Internet protocol address where the electronic signature was provided.
• SignDate: string (date)
  Title: Date of Signature

  Read Only: true

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

  Read Only: true

  Maximum Length: 400

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

  Read Only: true

  Maximum Length: 120

  Name of the signer for an electronic signature task.
• StageName: string
  Read Only: true

  Name of the phase in a journey with multiple phases.
• StageSequence: integer
  Read Only: true

  Sequence of the phase in a journey with multiple phases.
• Status: string
  Title: Status Code

  Read Only: true

  Maximum Length: 60

  Code for the task status.
• StatusCategory: string
  Title: Status Category

  Read Only: true

  Category of the 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

  Read Only: true

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

  Read Only: true

  Expected initiation date of the task.
• Type: string
  Title: Type Code

  Read Only: true

  Maximum Length: 80

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

  Read Only: true

  Maximum Length: 80

  Meaning of the task type.
• WorkerJourneyTaskId: integer (int64)
  Title: Journey Task ID

  Read Only: true

  Unique identifier of the journey task.

{
    "type":"object",
    "properties":{
        "ContentProviderCode":{
            "maxLength":"240",
            "type":"string",
            "description":"Code of the user-defined content task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DeferredStartDate":{
            "title":"Deferred Task Start Date",
            "type":"string",
            "description":"Start date for the deferred task.",
            "format":"date",
            "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,
            "readOnly":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
        },
        "EmbeddedApplicationTaskCode":{
            "maxLength":"240",
            "type":"string",
            "description":"Code of the embedded application task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ActualStartDate":{
            "title":"Actual Start Date",
            "type":"string",
            "description":"Date on which the task was opened.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Name":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the journey task.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "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
        },
        "OwnerType":{
            "title":"Owner Type",
            "maxLength":"30",
            "type":"string",
            "description":"Task owner type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AllowAttachmentFlag":{
            "title":"Allow Attachments",
            "type":"boolean",
            "description":"Indicates whether attachments are enabled for a task. Valid values are Yes and No. The default value is No.",
            "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"
                ]
            }
        },
        "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"
            }
        },
        "SignerEmail":{
            "title":"Email of Signer",
            "maxLength":"400",
            "type":"string",
            "description":"Email address of the signer for an electronic signature task.",
            "nullable":true,
            "readOnly":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
        },
        "Status":{
            "title":"Status Code",
            "maxLength":"60",
            "type":"string",
            "description":"Code for the task status.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DependentTaskId":{
            "title":"Preceding Task ID",
            "type":"integer",
            "description":"Primary key or unique identifier of the dependent task.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "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,
            "readOnly":true,
            "x-queryable":false
        },
        "TargetEndDate":{
            "title":"Target End Date",
            "type":"string",
            "description":"Due date of the task.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PerformerPersonId":{
            "title":"Performer Person ID",
            "type":"integer",
            "description":"Person identifier of the task performer. Applicable only in case of a single task performer.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Sequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"Task display ordering sequence. Default is 1.",
            "format":"int32",
            "nullable":true,
            "readOnly":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,
            "readOnly":true,
            "x-queryable":false
        },
        "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
        },
        "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
        },
        "PerformerName":{
            "title":"Performer Name",
            "type":"string",
            "description":"Person display name of task performer in case of single performer. Else, returns 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
        },
        "ParentWorkerJourneyId":{
            "title":"Worker Journey ID",
            "type":"integer",
            "description":"Unique identifier of the parent enterprise onboarding checklist.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "OwnerName":{
            "title":"Owner Name",
            "type":"string",
            "description":"Person display name of task owner in case of single owner. Else, returns responsibility type name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "OwnerPersonId",
                    "OwnerType",
                    "OwnerDisplayName",
                    "OwnerTypeMeaning"
                ]
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"4000",
            "type":"string",
            "description":"Description of the task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StageSequence":{
            "type":"integer",
            "description":"Sequence of the phase in a journey with multiple phases.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ActionSendReminder":{
            "title":"Send Reminder",
            "type":"string",
            "description":"Setting that determines if the signed in user can send a reminder for a task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ApplicationTaskName":{
            "title":"Application Task",
            "type":"string",
            "description":"Display name of the application task.",
            "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
        },
        "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
        },
        "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
        },
        "AllowCommentFlag":{
            "title":"Allow Comments",
            "type":"boolean",
            "description":"Indicates whether comments are enabled for a task. Valid values are Yes and No. The default value is No.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StatusCategory":{
            "title":"Status Category",
            "type":"string",
            "description":"Category of the 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",
                    "VideoTypeMeaning",
                    "LearnTypeMeaning"
                ]
            }
        },
        "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,
            "readOnly":true,
            "x-queryable":false
        },
        "ConfigurableFormContext":{
            "title":"Configurable Form",
            "maxLength":"80",
            "type":"string",
            "description":"Descriptive 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
        },
        "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
        },
        "Notes":{
            "title":"Notes",
            "type":"string",
            "description":"Notes for the 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,
            "readOnly":true,
            "x-queryable":false
        },
        "CompletedByDisplayName":{
            "title":"Completed by Person Name",
            "type":"string",
            "description":"Name of the person who completed the task.",
            "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
        },
        "ActualEndDate":{
            "title":"Actual End Date",
            "type":"string",
            "description":"End date of the task.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StageName":{
            "type":"string",
            "description":"Name of the phase in a journey with multiple phases.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"4000",
            "type":"string",
            "description":"Comments for the task.",
            "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
        },
        "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":"Meaning of the task type.",
            "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
        },
        "Type":{
            "title":"Type Code",
            "maxLength":"80",
            "type":"string",
            "description":"Code for the task action type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "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
        },
        "OpenReportInSamePageFlag":{
            "type":"boolean",
            "description":"Indicates whether the report should open in the existing page or a new page. Valid values are Yes and No. The default value is Yes.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ReportPath":{
            "title":"Report Path",
            "maxLength":"1000",
            "type":"string",
            "description":"Path to the report in BI Catalog.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":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
        },
        "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,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ActionURL":{
            "title":"URL",
            "maxLength":"1000",
            "type":"string",
            "description":"URL associated with the task that's entered on the setup screen.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OwnerPersonId":{
            "title":"Owner Person ID",
            "type":"integer",
            "description":"Identifier of the task owner. Applicable only in case of a single task owner.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

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 : workerJourneys-contacts-item-response

Type: object

Show Source

• ContactEmail: string
  Title: Contact Email

  Read Only: true

  Work email of the contact.
• ContactName: string
  Title: Contact Name

  Read Only: true

  Person name of the contact.
• ContactPersonId: integer
  Title: Contact Person ID

  Read Only: true

  Internal identifier for the contact.
• ContactPersonNumber: string
  Title: Person Number

  Read Only: true

  Person number of the contact.
• links: array Links
  Title: Links

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

  Read Only: true

  Maximum Length: 30

  Title of the contact. Values are from the ORA_PER_ONB_CONTACT_TITLE lookup. For example, ONBOARDING_SPONSOR
• TitleMeaning: string
  Title: Contact Meaning

  Read Only: true

  Maximum Length: 80

  Meaning of the contact title. For example, Onboarding Sponsor.
• Type: string
  Title: Contact Type

  Read Only: true

  Maximum Length: 30

  Type of contact. Valid values are from the ORA_PER_ONB_CONTACT_TYPE lookup. For example, Line Manager, Area of Responsibility.
• TypeMeaning: string
  Title: Contact Meaning

  Read Only: true

  Maximum Length: 80

  Meaning of the contact type.
• WorkerJourneyContactId: integer (int64)
  Title: Contact ID

  Read Only: true

  Unique identifier of the journey contact.

{
    "type":"object",
    "properties":{
        "Type":{
            "title":"Contact Type",
            "maxLength":"30",
            "type":"string",
            "description":"Type of contact. Valid values are from the ORA_PER_ONB_CONTACT_TYPE lookup. For example, Line Manager, Area of Responsibility.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "WorkerJourneyContactId":{
            "title":"Contact ID",
            "type":"integer",
            "description":"Unique identifier of the journey contact.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "ContactPersonId":{
            "title":"Contact Person ID",
            "type":"integer",
            "description":"Internal identifier for the contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ContactEmail":{
            "title":"Contact Email",
            "type":"string",
            "description":"Work email of the contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Title":{
            "title":"Contact Title",
            "maxLength":"30",
            "type":"string",
            "description":"Title of the contact. Values are from the ORA_PER_ONB_CONTACT_TITLE lookup. For example, ONBOARDING_SPONSOR",
            "nullable":false,
            "readOnly":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"
            }
        },
        "ContactPersonNumber":{
            "title":"Person Number",
            "type":"string",
            "description":"Person number of the contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ContactName":{
            "title":"Contact Name",
            "type":"string",
            "description":"Person name of the contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "TitleMeaning":{
            "title":"Contact Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of the contact title. For example, Onboarding Sponsor.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "TypeMeaning":{
            "title":"Contact Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of the contact type.",
            "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 : workerJourneys-events-item-response

Type: object

Show Source

• Category: string
  Title: Category Code

  Read Only: true

  Maximum Length: 30

  Event category code. Values are from ORA_PER_ONB_CONTENT_SBTYP_EVNT lookup. For example, Insight
• CategoryMeaning: string
  Title: Category Meaning

  Read Only: true

  Maximum Length: 80

  Event category meaning. For example, Insight.
• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 1000

  Description of the event.
• EventURL: string
  Title: URL

  Read Only: true

  Maximum Length: 240

  URL of the event.
• ImageURL: string
  Title: Image URL

  Read Only: true

  Maximum Length: 240

  URL of the event background image.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Sequence: integer (int32)
  Title: Sequence

  Read Only: true

  Display order of the events.
• Title: string
  Title: Title

  Read Only: true

  Maximum Length: 120

  Title of the event.
• WorkerJourneyEventId: integer (int64)
  Title: Journey Event ID

  Read Only: true

  Unique identifier of the journey event.

{
    "type":"object",
    "properties":{
        "Category":{
            "title":"Category Code",
            "maxLength":"30",
            "type":"string",
            "description":"Event category code. Values are from ORA_PER_ONB_CONTENT_SBTYP_EVNT lookup. For example, Insight",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"Description of the event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "WorkerJourneyEventId":{
            "title":"Journey Event ID",
            "type":"integer",
            "description":"Unique identifier of the journey event.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "EventURL":{
            "title":"URL",
            "maxLength":"240",
            "type":"string",
            "description":"URL of the event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ImageURL":{
            "title":"Image URL",
            "maxLength":"240",
            "type":"string",
            "description":"URL of the event background image.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Title":{
            "title":"Title",
            "maxLength":"120",
            "type":"string",
            "description":"Title of the event.",
            "nullable":false,
            "readOnly":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"
            }
        },
        "Sequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"Display order of the events.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"9"
            }
        },
        "CategoryMeaning":{
            "title":"Category Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Event category meaning. For example, Insight.",
            "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 : workerJourneys-notes-item-response

Type: object

Show Source

• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 1000

  Description of the note.
• EventDate: string (date)
  Title: Meeting Date

  Read Only: true

  Date for the meeting type note.
• EventLocation: string
  Title: Meeting Location

  Read Only: true

  Maximum Length: 240

  Location for the meeting type note.
• EventTime: string
  Title: Meeting Time

  Read Only: true

  Maximum Length: 10

  Time for the meeting type note.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Sequence: integer (int32)
  Title: Sequence

  Read Only: true

  Display order of the notes.
• Title: string
  Title: Title

  Read Only: true

  Maximum Length: 120

  Title of the note.
• Type: string
  Title: Type

  Read Only: true

  Maximum Length: 30

  Note subtype code. Values are from the ORA_PER_ONB_CONTENT_SBTYP_NOTE lookup. For example, Meeting Note, Standard Note.
• TypeMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Note subtype meaning.
• WorkerJourneyNoteId: integer (int64)
  Title: Journey Notes ID

  Read Only: true

  Unique identifier of the journey notes.

{
    "type":"object",
    "properties":{
        "Type":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"Note subtype code. Values are from the ORA_PER_ONB_CONTENT_SBTYP_NOTE lookup. For example, Meeting Note, Standard Note.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "EventDate":{
            "title":"Meeting Date",
            "type":"string",
            "description":"Date for the meeting type note.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"Description of the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "EventTime":{
            "title":"Meeting Time",
            "maxLength":"10",
            "type":"string",
            "description":"Time for the meeting type note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "EventLocation":{
            "title":"Meeting Location",
            "maxLength":"240",
            "type":"string",
            "description":"Location for the meeting type note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "WorkerJourneyNoteId":{
            "title":"Journey Notes ID",
            "type":"integer",
            "description":"Unique identifier of the journey notes.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "Title":{
            "title":"Title",
            "maxLength":"120",
            "type":"string",
            "description":"Title of the note.",
            "nullable":false,
            "readOnly":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"
            }
        },
        "Sequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"Display order of the notes.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"9"
            }
        },
        "TypeMeaning":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Note subtype meaning.",
            "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 : workerJourneys-properties-item-response

Type: object

Show Source

• AssigneeDefaultValue: string
  Default value of the journey template property for assignee.
• AssigneeLookupType: string
  Journey template property type for assignee.
• AssigneeValue: string
  Value of the journey template property for assignee.
• Category: string
  Name of the group for journey template property.
• CategoryMeaning: string
  Meaning of the group for journey template property.
• Code: string
  Code of the journey template property
• DisabledForAssigneeFlag: boolean
  Indicates if the journey template property is disabled for assignee.
• DisabledForInitiatorFlag: boolean
  Indicates if journey template property is disabled for initiator.
• DisabledForLineManagerFlag: boolean
  Indicates if journey template property is disabled for line manager.
• DisabledForOthersFlag: boolean
  Indicates if the journey template is disabled for other users.
• InitiatorDefaultValue: string
  Default value of the journey template property for initiator.
• InitiatorLookupType: string
  Journey template property type for initiator.
• InitiatorValue: string
  Value of the journey template property for initiator.
• Level: string
  Level of the journey template property.
• LineManagerDefaultValue: string
  Default value of the journey template property for line manager.
• LineManagerLookupType: string
  Journey template property type for line manager.
• LineManagerValue: string
  Value of the journey template property for assignee.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Name of the journey template property.
• OthersDefaultValue: string
  Default value of the journey template property for other user.
• OthersLookupType: string
  Journey template property type for assignee.
• OthersValue: string
  Value of the journey template property for other user.
• OverriddenFlag: boolean
  Indicates if the journey template property is overridden.

{
    "type":"object",
    "properties":{
        "OthersDefaultValue":{
            "type":"string",
            "description":"Default value of the journey template property for other user.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Category":{
            "type":"string",
            "description":"Name of the group for journey template property.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "DisabledForAssigneeFlag":{
            "type":"boolean",
            "description":"Indicates if the journey template property is disabled for assignee.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "OthersValue":{
            "type":"string",
            "description":"Value of the journey template property for other user.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "LineManagerValue":{
            "type":"string",
            "description":"Value of the journey template property for assignee.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "InitiatorValue":{
            "type":"string",
            "description":"Value of the journey template property for initiator.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "AssigneeLookupType":{
            "type":"string",
            "description":"Journey template property type for assignee.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Code":{
            "type":"string",
            "description":"Code of the journey template property",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CategoryMeaning":{
            "type":"string",
            "description":"Meaning of the group for journey template property.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "DisabledForInitiatorFlag":{
            "type":"boolean",
            "description":"Indicates if journey template property is disabled for initiator.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Name":{
            "type":"string",
            "description":"Name of the journey template property.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "AssigneeValue":{
            "type":"string",
            "description":"Value of the journey template property for assignee.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "OthersLookupType":{
            "type":"string",
            "description":"Journey template property type for assignee.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "OverriddenFlag":{
            "type":"boolean",
            "description":"Indicates if the journey template property is overridden.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "LineManagerDefaultValue":{
            "type":"string",
            "description":"Default value of the journey template property for line manager.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "InitiatorDefaultValue":{
            "type":"string",
            "description":"Default value of the journey template property for initiator.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "DisabledForLineManagerFlag":{
            "type":"boolean",
            "description":"Indicates if journey template 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 template property.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "LineManagerLookupType":{
            "type":"string",
            "description":"Journey template property type for line manager.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "InitiatorLookupType":{
            "type":"string",
            "description":"Journey template property type for initiator.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "AssigneeDefaultValue":{
            "type":"string",
            "description":"Default value of the journey template property for assignee.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "DisabledForOthersFlag":{
            "type":"boolean",
            "description":"Indicates if the journey template is disabled for other users.",
            "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 : workerJourneys-taskCounts-item-response

Type: object

Show Source

• AvailableOthersTasks: number
  Read Only: true

  Count of tasks in the journey that are active and aren't deferred for users other than the signed in user.
• AvailableSelfTasks: number
  Title: Active Tasks for Self

  Read Only: true

  Count of tasks in the journey that are active and aren't deferred for the signed in user.
• CompletedOthersTasks: number
  Title: Others Completed Tasks

  Read Only: true

  Count of tasks to be completed by users other than the signed in user or the journey assignee in the journey.
• CompletedSelfTasks: number
  Title: Completed Tasks for Self

  Read Only: true

  Count of tasks completed by the signed in user in the journey.
• CompletedTasks: number
  Title: Total Completed Tasks

  Read Only: true

  Total number of completed tasks in the journey.
• CompletedWorkerTasks: number
  Title: Completed Tasks for Assignee

  Read Only: true

  Count of tasks completed by journey assignee in the journey.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OthersTasks: number
  Title: Others Tasks

  Read Only: true

  Count of tasks to be performed by users other than the signed in user or the journey assignee in the journey.
• OverdueSelfTasks: number
  Title: Overdue Tasks for Self

  Read Only: true

  Count of overdue tasks for the signed in user in the journey.
• OverdueTasks: number
  Title: Total Overdue Tasks

  Read Only: true

  Total number of overdue tasks in the journey.
• SelfTasks: number
  Title: Tasks for Self

  Read Only: true

  Count of tasks for the signed in user in the journey.
• Tasks: number
  Title: Total Tasks

  Read Only: true

  Total tasks in the journey.
• WorkerJourneyId: integer (int64)
  Title: Worker Journey ID

  Read Only: true

  Unique identifier of the journey.
• WorkerTasks: number
  Title: Assignee Tasks

  Read Only: true

  Count of assignee tasks in the journey.

{
    "type":"object",
    "properties":{
        "SelfTasks":{
            "title":"Tasks for Self",
            "type":"number",
            "description":"Count of tasks for the signed in user in the journey.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "WorkerTasks":{
            "title":"Assignee Tasks",
            "type":"number",
            "description":"Count of assignee tasks in the journey.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Tasks":{
            "title":"Total Tasks",
            "type":"number",
            "description":"Total tasks in the journey.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "OthersTasks":{
            "title":"Others Tasks",
            "type":"number",
            "description":"Count of tasks to be performed by users other than the signed in user or the journey assignee in the journey.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "OverdueSelfTasks":{
            "title":"Overdue Tasks for Self",
            "type":"number",
            "description":"Count of overdue tasks for the signed in user in the journey.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CompletedSelfTasks":{
            "title":"Completed Tasks for Self",
            "type":"number",
            "description":"Count of tasks completed by the signed in user in the journey.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "CompletedWorkerTasks":{
            "title":"Completed Tasks for Assignee",
            "type":"number",
            "description":"Count of tasks completed by journey assignee in the journey.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "CompletedOthersTasks":{
            "title":"Others Completed Tasks",
            "type":"number",
            "description":"Count of tasks to be completed by users other than the signed in user or the journey assignee in the journey.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "OverdueTasks":{
            "title":"Total Overdue Tasks",
            "type":"number",
            "description":"Total number of overdue tasks in the journey.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "WorkerJourneyId":{
            "title":"Worker Journey ID",
            "type":"integer",
            "description":"Unique identifier of the journey.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "AvailableOthersTasks":{
            "type":"number",
            "description":"Count of tasks in the journey that are active and aren't deferred for users other than the signed in user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AvailableSelfTasks":{
            "title":"Active Tasks for Self",
            "type":"number",
            "description":"Count of tasks in the journey that are active and aren't deferred for the signed in user.",
            "nullable":true,
            "readOnly":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"
            }
        },
        "CompletedTasks":{
            "title":"Total Completed Tasks",
            "type":"number",
            "description":"Total number of completed tasks in the journey.",
            "nullable":true,
            "readOnly":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 : workerJourneys-tasks-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
  Title: Add Task to Calendar

  Read Only: true

  Setting that determines if the signed in user can add the task as a calendar event.
• 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 a task 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.
• ActionSendReminder: string
  Read Only: true

  Maximum Length: 255

  Setting that determines if the signed in user can send a reminder for a task.
• ActionURL: string
  Title: URL

  Maximum Length: 1000

  URL associated with the task that's entered on the setup screen.
• 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
  Task attachment addition to document records.
• AddToCalendar: string (byte)
  Title: Add to Calendar

  Read Only: true

  Addition of the task as a calendar event.
• AddToLibraryFlag: boolean
  Task addition to personal library.
• AllowAttachmentFlag: boolean
  Indicates whether attachments are enabled for a task. Valid values are Yes or No. The default value is No.
• AllowCommentFlag: boolean
  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
  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

  Display name of the application task
• AttachmentDocumentTypeId: integer (int64)
  Title: Document Type for Attachments

  Attachments to add to document records for the given document type.
• AttachmentDocumentTypeName: string
  Title: Document Type Name for Attachments

  Read Only: true

  Maximum Length: 80

  Attachments to add to document records for the given document type name.
• 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 for an electronic signature task.
• AuthenticationInstructionText: string
  Title: Password Authentication Instruction Text

  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

  Name of the person who completed the task.
• CompletedByPersonId: string
  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

  End date of the task.
• ConfigurableFormContext: string
  Title: Configurable Form

  Maximum Length: 80

  Descriptive 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 task.
• CreationDate: string (date-time)
  Read Only: true

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

  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
  Maximum Length: 240

  Code of the embedded application task.
• EmbeddedApplicationTaskTypeId: integer (int64)
  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
  Title: Error Details

  Read Only: true

  Error details, if any, for the task.
• ErrorMessage: string
  Title: Error Message

  Read Only: true

  Error message, if any, for the task.
• ErrorType: string
  Title: Error Type

  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.
• JourneyTaskId: integer (int64)
  Title: Task Identifier

  Read Only: true

  Identifier of the journey task.
• 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
  Maximum Length: 80

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

  Meaning of the learning content type.
• LearningItemId: integer (int64)
  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 journey task.
• Notes: string (byte)
  Title: Notes

  Notes for the 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

  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.
• OpenInSamePageFlag: boolean
  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
  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

  Person display name of task owner in case of single owner. Else, returns responsibility type name.
• OwnerPersonId: integer (int64)
  Title: Owner Person ID

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

  Maximum Length: 30

  Default Value: ORA_CHK_ADHOC_USER

  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.
• ParentJourneyId: integer (int64)
  Title: Allocated Checklist Identifier

  Read Only: true

  Identifier of the parent journey.
• PerformerName: string
  Title: Performer Name

  Read Only: true

  Person display name of task performer in case of single performer. Else, returns responsibility type name.
• PerformerPersonId: integer (int64)
  Title: Performer Person ID

  Person identifier of the task performer. Available only in case of single performer, is updatable when adding a new task.
• PerformerType: string
  Title: Performer Type

  Read Only: true

  Task performer type.
• PerformerTypeMeaning: string
  Title: Performer

  Read Only: true

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

  The properties resource is the child of the workerJourneys resource. It includes all the journey properties associated with the parent journey template.
• QuestionnaireId: integer (int64)
  Title: Questionnaire

  Internal identifier of the 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

  Default Value: ORA_CHK_BFR_DUE_DT

  Task reminder that's relative either to due date or start date.
• ReminderRelativeToMeaning: string
  Title: Enable Reminder Meaning

  Read Only: true

  Maximum Length: 80

  Meaning of task reminder relative to date.
• ReportPath: string
  Title: Report Path

  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. Default is 1.
• 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
  Title: Signature Validation Option

  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
  Title: Signer Password

  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.
• StageJourneyId: integer (int64)
  Title: Allocated Step Checklist Identifier

  Read Only: true

  Unique identifier for the journey phase.
• Status: string
  Title: Status Code

  Maximum Length: 60

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 80

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

  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.
• TargetDuration: integer (int32)
  Title: Target Duration

  Duration of the task.
• TargetDurationUOM: string
  Title: Target Duration UOM

  Maximum Length: 30

  Unit of measure for the task duration, such as Days, Weeks, Months.
• TargetDurationUOMMeaning: string
  Title: Target Duration UOM Meaning

  Read Only: true

  Maximum Length: 80

  Meaning of unit of measure used in the task target duration.
• 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: 30

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

  Read Only: true

  Maximum Length: 80

  Task action type.
• VideoType: string
  Maximum Length: 80

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

  Meaning of video type.
• VideoURL: string
  Maximum Length: 1000

  URL of the video.
• WorkAuthorizationProgressStatus: string
  Title: Work Authorization Status Code

  Read Only: true

  I 9 progress status code that displays if the I 9 process is completed.
• WorkAuthorizationProgressStatusMeaning: string
  Title: Work Authorization Status

  Read Only: true

  I 9 progress status that displays if the I 9 process is completed.
• WorkAuthorizationVerificationStatus: string
  Title: Work Authorization Verification Status Code

  Read Only: true

  I 9 verification status code.
• WorkAuthorizationVerificationStatusMeaning: string
  Title: Work Authorization Verification Status

  Read Only: true

  I 9 verification status.
• WorkerJourneyTaskId: integer (int64)
  Title: Journey Task ID

  Unique identifier of the journey task.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date on which the 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":"Task attachment addition to 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 a task 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-hints":{
                "dependencies":[
                    "SaveAttachmentsToDORFor"
                ]
            },
            "x-queryable":true
        },
        "ActualStartDate":{
            "title":"Actual Start Date",
            "type":"string",
            "description":"Date on which the task was opened.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "WorkAuthorizationVerificationStatusMeaning":{
            "title":"Work Authorization Verification Status",
            "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,
            "default":"ORA_CHK_ADHOC_USER",
            "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":{
            "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"
                ]
            }
        },
        "SignatureValidationMode":{
            "title":"Signature Validation Option",
            "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
            }
        },
        "QuestionnaireId":{
            "title":"Questionnaire",
            "type":"integer",
            "description":"Internal identifier of the questionnaire.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "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 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/workerJourneys-tasks-learningItems-item-response"
            }
        },
        "TargetEndDate":{
            "title":"Target End Date",
            "type":"string",
            "description":"Due date of the task.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "WorkAuthorizationProgressStatus":{
            "title":"Work Authorization Status Code",
            "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/workerJourneys-tasks-tasksDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "AttachmentDocumentTypeName":{
            "title":"Document Type Name for Attachments",
            "maxLength":"80",
            "type":"string",
            "description":"Attachments to add to document records for the given document type name.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "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/workerJourneys-tasks-questionnaireResponses-item-response"
            }
        },
        "WorkAuthorizationProgressStatusMeaning":{
            "title":"Work Authorization Status",
            "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":"string",
            "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"
                ]
            }
        },
        "AddToLibraryFlag":{
            "type":"boolean",
            "description":"Task addition to personal library.",
            "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/workerJourneys-tasks-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":{
            "title":"Add Task to Calendar",
            "type":"string",
            "description":"Setting that determines if the signed in user can add the task as a calendar event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StageJourneyId":{
            "title":"Allocated Step Checklist Identifier",
            "type":"integer",
            "description":"Unique identifier for the journey phase.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "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/workerJourneys-tasks-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
        },
        "ApplicationTaskName":{
            "title":"Application Task",
            "type":"string",
            "description":"Display name of the application task",
            "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":{
            "title":"Error Details",
            "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,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "AllowNoteTitleFlag":{
            "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,
            "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
            }
        },
        "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",
            "type":"string",
            "description":"Category of the task status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "JourneyTaskId":{
            "title":"Task Identifier",
            "type":"integer",
            "description":"Identifier of the journey task.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "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":{
            "title":"Error Type",
            "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":{
            "title":"Signer Password",
            "type":"string",
            "description":"Authentication password of the signer in an electronic signature task.",
            "nullable":true,
            "x-queryable":false
        },
        "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":"Descriptive flexfield context code for configurable form task type.",
            "nullable":true,
            "x-queryable":false
        },
        "CompletionDate":{
            "title":"Completed On",
            "type":"string",
            "description":"End date of the task.",
            "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
        },
        "TargetDurationUOM":{
            "title":"Target Duration UOM",
            "maxLength":"30",
            "type":"string",
            "description":"Unit of measure for the task duration, such as Days, Weeks, Months.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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,
            "default":"ORA_CHK_BFR_DUE_DT",
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            }
        },
        "EmbeddedApplicationTaskTypeId":{
            "type":"integer",
            "description":"Unique identifier of the embedded application task.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "VideoURL":{
            "maxLength":"1000",
            "type":"string",
            "description":"URL of the video.",
            "nullable":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":"30",
            "type":"string",
            "description":"Code of the task action type.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "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
            }
        },
        "ReportPath":{
            "title":"Report Path",
            "maxLength":"1000",
            "type":"string",
            "description":"Path to the report in BI Catalog.",
            "nullable":true,
            "x-queryable":false
        },
        "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,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "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
        },
        "TargetDurationUOMMeaning":{
            "title":"Target Duration UOM Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of unit of measure used in the task target duration.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "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 that's entered on the setup screen.",
            "nullable":true,
            "x-queryable":false
        },
        "ErrorMessage":{
            "title":"Error Message",
            "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 for an electronic signature task.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "BasicEsignConfigAttributes"
                ]
            },
            "x-queryable":true
        },
        "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/workerJourneys-tasks-documents-item-response"
            }
        },
        "DeferredStartDate":{
            "title":"Deferred Task Start Date",
            "type":"string",
            "description":"Deferred start date for a deferred task.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "LearningContentType":{
            "maxLength":"80",
            "type":"string",
            "description":"Type of learning content.",
            "nullable":true,
            "x-queryable":false
        },
        "EmbeddedApplicationTaskCode":{
            "maxLength":"240",
            "type":"string",
            "description":"Code of the embedded application task.",
            "nullable":true,
            "x-queryable":false
        },
        "WorkAuthorizationVerificationStatus":{
            "title":"Work Authorization Verification Status Code",
            "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 journey 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
        },
        "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"
                ]
            }
        },
        "NoteTitle":{
            "title":"Notes Title",
            "maxLength":"150",
            "type":"string",
            "description":"Title of the Notes section in the task.",
            "nullable":true,
            "x-queryable":false
        },
        "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
            }
        },
        "DependentTaskName":{
            "title":"Preceding Task",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the dependent task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":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,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "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, is updatable when adding a new task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Sequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"Task display ordering sequence. Default is 1.",
            "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
        },
        "ParentJourneyId":{
            "title":"Allocated Checklist Identifier",
            "type":"integer",
            "description":"Identifier of the parent journey.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "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
            }
        },
        "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":"Person display name of task performer in case of single performer. Else, returns 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,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LearningItemId":{
            "type":"integer",
            "description":"Unique identifier of the learning item.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ReminderRelativeToMeaning":{
            "title":"Enable Reminder Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of task reminder relative to date.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "TargetDuration":{
            "title":"Target Duration",
            "type":"integer",
            "description":"Duration of the task.",
            "format":"int32",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "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":"Person display name of task owner in case of single owner. Else, returns responsibility type name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "OwnerPersonId",
                    "OwnerType",
                    "OwnerDisplayName",
                    "OwnerTypeMeaning"
                ]
            }
        },
        "AddToCalendar":{
            "title":"Add to Calendar",
            "type":"string",
            "description":"Addition of the task as a calendar event.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ActionSendReminder":{
            "maxLength":"255",
            "type":"string",
            "description":"Setting that determines if the signed in user can send a reminder for a task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AuthenticationInstructionText":{
            "title":"Password Authentication Instruction Text",
            "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
        },
        "VideoType":{
            "maxLength":"80",
            "type":"string",
            "description":"Type of video.",
            "nullable":true,
            "x-queryable":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
        },
        "AllowCommentFlag":{
            "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
            }
        },
        "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
        },
        "CompletedByDisplayName":{
            "title":"Completed by Person Name",
            "type":"string",
            "description":"Name of the person who completed the task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Notes":{
            "title":"Notes",
            "type":"string",
            "description":"Notes for the 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
        },
        "StatusMeaning":{
            "title":"Status",
            "maxLength":"80",
            "type":"string",
            "description":"Status of the task.",
            "nullable":false,
            "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,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "properties":{
            "title":"Journey Task Properties",
            "type":"array",
            "description":"The properties resource is the child of the workerJourneys resource. It includes all the journey properties associated with the parent journey template.",
            "items":{
                "$ref":"#/components/schemas/workerJourneys-tasks-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 workerJourneys-tasks-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/workerJourneys-tasks-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 workerJourneys-tasks-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/workerJourneys-tasks-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 workerJourneys-tasks-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/workerJourneys-tasks-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 workerJourneys-tasks-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/workerJourneys-tasks-notifications-item-response"
    }
}

Nested Schema : Journey Task Properties

Type: array

Title: Journey Task Properties

The properties resource is the child of the workerJourneys resource. It includes all the journey properties associated with the parent journey template.

Show Source

• Array of: object workerJourneys-tasks-properties-item-response

{
    "title":"Journey Task Properties",
    "type":"array",
    "description":"The properties resource is the child of the workerJourneys resource. It includes all the journey properties associated with the parent journey template.",
    "items":{
        "$ref":"#/components/schemas/workerJourneys-tasks-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 workerJourneys-tasks-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/workerJourneys-tasks-questionnaireResponses-item-response"
    }
}

Nested Schema : tasksDFF

Type: array

Show Source

• Array of: object workerJourneys-tasks-tasksDFF-item-response

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

Nested Schema : workerJourneys-tasks-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 : workerJourneys-tasks-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 : workerJourneys-tasks-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 : workerJourneys-tasks-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 : workerJourneys-tasks-properties-item-response

Type: object

Show Source

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

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

{
    "type":"object",
    "properties":{
        "OthersDefaultValue":{
            "type":"string",
            "description":"Default value of the journey template task property for other user.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "DisabledForPerformerFlag":{
            "type":"boolean",
            "description":"Indicates if the journey template task property is disabled for performer. Default value depends on the task type.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Category":{
            "type":"string",
            "description":"Name of the group for journey template task property.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "OthersValue":{
            "type":"string",
            "description":"Property value of the journey template task for other user.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "LineManagerValue":{
            "type":"string",
            "description":"Value of the journey template task property for line manager.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Sequence":{
            "type":"integer",
            "description":"Sequence of the journey template task property.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Code":{
            "type":"string",
            "description":"Property code of journey template task.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CategoryMeaning":{
            "type":"string",
            "description":"Meaning of group for journey template task property.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Name":{
            "type":"string",
            "description":"Name of the journey template task property.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "OthersLookupType":{
            "type":"string",
            "description":"Journey template task property type for other user.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "DisabledForOwnerFlag":{
            "type":"boolean",
            "description":"Indicates if the journey template task property is disabled for owner. Default value depends on the task type.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "PerformerDefaultValue":{
            "type":"string",
            "description":"Default value of the journey template task property for performer.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "OverriddenFlag":{
            "type":"boolean",
            "description":"Indicates if the journey template property is overridden. Default value depends on the task type.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "PerformerValue":{
            "type":"string",
            "description":"Property value of the journey template task for performer.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "LineManagerDefaultValue":{
            "type":"string",
            "description":"Default value of the journey template task property for line manager.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "DisabledForLineManagerFlag":{
            "type":"boolean",
            "description":"Indicates if journey template task property is disabled for line manager. Default value depends on the task type.",
            "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":"Property level for the journey template task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "PerformerLookupType":{
            "type":"string",
            "description":"Journey template task property for performer.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "LineManagerLookupType":{
            "type":"string",
            "description":"Journey template task property for performer. Lookup type of the journey template task property for line manager.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "OwnerValue":{
            "type":"string",
            "description":"Property value of the journey template task for owner.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "OwnerLookupType":{
            "type":"string",
            "description":"Journey template task property type for owner.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "DisabledForOthersFlag":{
            "type":"boolean",
            "description":"Indicates if the journey template task property is disabled for other users. Default value depends on the task type.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "OwnerDefaultValue":{
            "type":"string",
            "description":"Default value of the journey template task property for 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 : workerJourneys-tasks-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/workerJourneys-tasks-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 workerJourneys-tasks-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/workerJourneys-tasks-questionnaireResponses-questionResponses-item-response"
    }
}

Nested Schema : workerJourneys-tasks-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/workerJourneys-tasks-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 workerJourneys-tasks-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/workerJourneys-tasks-questionnaireResponses-questionResponses-questionResponseAttachments-item-response"
    }
}

Nested Schema : workerJourneys-tasks-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 : workerJourneys-tasks-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"
    }
}

Nested Schema : workerJourneys-taskTypes-item-response

Type: object

Show Source

• Code: string
  Maximum Length: 61

  Code of the journey template task type property.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Read Only: true

  Maximum Length: 161

  Name of the journey template task type property.
• properties: array Journey Task Properties
  Title: Journey Task Properties

  The properties resource is the child of the workerJourneys resource. It includes all the journey properties associated with the parent journey template.
• SubType: string
  Read Only: true

  Maximum Length: 30

  Subtype of the journey template task type property.
• SubTypeMeaning: string
  Read Only: true

  Maximum Length: 80

  Subtype meaning of the journey template task type property.
• Type: string
  Read Only: true

  Maximum Length: 30

  Type of the journey template task type property.
• TypeMeaning: string
  Read Only: true

  Maximum Length: 80

  Meaning of the journey template task type property.
• WorkerJourneyId: integer (int64)
  Identifier of the journey template task type property.

{
    "type":"object",
    "properties":{
        "WorkerJourneyId":{
            "type":"integer",
            "description":"Identifier of the journey template task type property.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Type":{
            "maxLength":"30",
            "type":"string",
            "description":"Type of the journey template task type property.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "SubType":{
            "maxLength":"30",
            "type":"string",
            "description":"Subtype of the journey template task type property.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "SubTypeMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"Subtype meaning of the journey template task type property.",
            "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"
            }
        },
        "Code":{
            "maxLength":"61",
            "type":"string",
            "description":"Code of the journey template task type property.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "properties":{
            "title":"Journey Task Properties",
            "type":"array",
            "description":"The properties resource is the child of the workerJourneys resource. It includes all the journey properties associated with the parent journey template.",
            "items":{
                "$ref":"#/components/schemas/workerJourneys-taskTypes-properties-item-response"
            }
        },
        "Name":{
            "maxLength":"161",
            "type":"string",
            "description":"Name of the journey template task type property.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "TypeMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of the journey template task type property.",
            "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 : Journey Task Properties

Type: array

Title: Journey Task Properties

The properties resource is the child of the workerJourneys resource. It includes all the journey properties associated with the parent journey template.

Show Source

• Array of: object workerJourneys-taskTypes-properties-item-response

{
    "title":"Journey Task Properties",
    "type":"array",
    "description":"The properties resource is the child of the workerJourneys resource. It includes all the journey properties associated with the parent journey template.",
    "items":{
        "$ref":"#/components/schemas/workerJourneys-taskTypes-properties-item-response"
    }
}

Nested Schema : workerJourneys-taskTypes-properties-item-response

Type: object

Show Source

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

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

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

Links

addTaskFromLibrary

Operation: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/action/addTaskFromLibrary

Parameters:

• WorkerJourneyId: $request.path.WorkerJourneyId

Adds a library task to a worker journey.

allStepTasks

Operation: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/allStepTasks

Parameters:

• WorkerJourneyId: $request.path.WorkerJourneyId

The allStepTasks resource is a child of the workerJourneys resource. It includes all the step tasks in the worker journey.

contacts

Operation: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/contacts

Parameters:

• WorkerJourneyId: $request.path.WorkerJourneyId

The contacts resource is a child of the workerJourneys resource. It includes a list of contacts associated with the worker journey.

events

Operation: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/events

Parameters:

• WorkerJourneyId: $request.path.WorkerJourneyId

The events resource is a child of the workerJourneys resource. It includes a list of events associated with the worker journey.

forceComplete

Operation: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/action/forceComplete

Parameters:

• WorkerJourneyId: $request.path.WorkerJourneyId

Force completes a worker journey.

notes

Operation: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/notes

Parameters:

• WorkerJourneyId: $request.path.WorkerJourneyId

The notes resource is a child of the workerJourneys resource. It includes the notes associated with the worker journey.

properties

Operation: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/properties

Parameters:

• WorkerJourneyId: $request.path.WorkerJourneyId

The properties resource is the child of the workerJourneys resource. It includes all the journey properties associated with the parent journey template.

taskCounts

Operation: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/taskCounts

Parameters:

• WorkerJourneyId: $request.path.WorkerJourneyId

The taskCounts resource is a child of the workerJourneys resource. It includes a summary of the tasks in the worker journey.

taskTypes

Operation: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/taskTypes

Parameters:

• WorkerJourneyId: $request.path.WorkerJourneyId

The taskTypes resource is the child of the workerJourneys resource. It includes all the task types associated with the parent journey template.

tasks

Operation: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks

Parameters:

• WorkerJourneyId: $request.path.WorkerJourneyId

The tasks resource is a child of the workerJourneys resource. It includes all the tasks in the worker journey.

Back to Top