Jump to

• Request
• Response

Update a journey template

patch

/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}

Request

Path Parameters

• JourneyId(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=

Header Parameters

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• allStepTasks: array All Step Tasks
  Title: All Step Tasks

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

  Number of days to consider for archiving journeys.
• BackgroundImage: string (byte)
  Background image displayed on the journey page.
• BackgroundImageFileName: string
  Maximum Length: 2048

  File name of the background image.
• BackgroundImageURL: string
  Maximum Length: 4000

  URL of the image displayed on the journey details page.
• BackgroundThumbnailURL: string
  Maximum Length: 4000

  URL of the image displayed on the journey card.
• Category: string
  Title: Category

  Maximum Length: 60

  Category code for the event. Values are from ORA_PER_ONB_CONTENT_SBTYP_EVNT lookup. For example, Insight.
• CompletionMessage: string
  Maximum Length: 720

  Message displayed on journey completion.
• contacts: array Contacts
  Title: Contacts

  The contacts resource is a child of the journeys resource. It includes a list of contacts associated with the parent journey template.
• CroppedBackgroundImage: string (byte)
  Cropped background image displayed on the journey page.
• Description: string
  Title: Description

  Maximum Length: 360

  Description of the task.
• DisplayNameFormat: string
  Maximum Length: 240

  Display name format of a journey template.
• events: array Events
  Title: Events

  The events resource is a child of the journeys resource. It includes all events associated with the parent journey template.
• MessageSubTitle: string
  Maximum Length: 720

  Subtitle of the message displayed in the journey details.
• MessageText: string
  Maximum Length: 400

  Message text displayed for a journey.
• MessageTitle: string
  Maximum Length: 400

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

  Maximum Length: 240

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

  The notes resource is a child of the journeys resource. It includes all the notes associated with the parent journey template.
• ObjectReferenceId: integer (int64)
  Reference identifier of the journey template object.
• properties: array Properties
  Title: Properties

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

  Number of days to consider for purging journeys.
• RawBackgroundImageURL: string
  Maximum Length: 4000

  URL of the original background image.
• tasks: array Tasks
  Title: Tasks

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

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

{
    "type":"object",
    "properties":{
        "BackgroundImageFileName":{
            "maxLength":"2048",
            "type":"string",
            "description":"File name of the background image.",
            "nullable":true,
            "x-queryable":false
        },
        "allStepTasks":{
            "title":"All Step Tasks",
            "type":"array",
            "description":"The allStepTasks resource is a child of the journeys resource. It includes all the tasks in the parent journey template.",
            "items":{
                "$ref":"#/components/schemas/journeys-allStepTasks-item-patch-request"
            }
        },
        "BackgroundImageURL":{
            "maxLength":"4000",
            "type":"string",
            "description":"URL of the image displayed on the journey details page.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Category":{
            "title":"Category",
            "maxLength":"60",
            "type":"string",
            "description":"Category code for the event. Values are from ORA_PER_ONB_CONTENT_SBTYP_EVNT lookup. For example, Insight.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"360",
            "type":"string",
            "description":"Description of the task.",
            "nullable":true,
            "x-queryable":false
        },
        "notes":{
            "title":"Notes",
            "type":"array",
            "description":"The notes resource is a child of the journeys resource. It includes all the notes associated with the parent journey template.",
            "items":{
                "$ref":"#/components/schemas/journeys-notes-item-patch-request"
            }
        },
        "DisplayNameFormat":{
            "maxLength":"240",
            "type":"string",
            "description":"Display name format of a journey template.",
            "nullable":true,
            "x-queryable":false
        },
        "CroppedBackgroundImage":{
            "type":"string",
            "description":"Cropped background image displayed on the journey page.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "BackgroundImageContentId"
                ]
            }
        },
        "MessageText":{
            "maxLength":"400",
            "type":"string",
            "description":"Message text displayed for a journey.",
            "nullable":true,
            "x-queryable":false
        },
        "BackgroundThumbnailURL":{
            "maxLength":"4000",
            "type":"string",
            "description":"URL of the image displayed on the journey card.",
            "nullable":true,
            "x-queryable":false
        },
        "Name":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the journey task.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "RawBackgroundImageURL":{
            "maxLength":"4000",
            "type":"string",
            "description":"URL of the original background image.",
            "nullable":true,
            "x-queryable":false
        },
        "MessageTitle":{
            "maxLength":"400",
            "type":"string",
            "description":"Title of the message displayed in the journey details.",
            "nullable":true,
            "x-queryable":false
        },
        "BackgroundImage":{
            "type":"string",
            "description":"Background image displayed on the journey page.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "RawImageContentId"
                ]
            }
        },
        "taskTypes":{
            "title":"Task Types",
            "type":"array",
            "description":"The taskTypes resource is the child of the journeys resource. It includes all the task types associated with the parent journey template.",
            "items":{
                "$ref":"#/components/schemas/journeys-taskTypes-item-patch-request"
            }
        },
        "MessageSubTitle":{
            "maxLength":"720",
            "type":"string",
            "description":"Subtitle of the message displayed in the journey details.",
            "nullable":true,
            "x-queryable":false
        },
        "CompletionMessage":{
            "maxLength":"720",
            "type":"string",
            "description":"Message displayed on journey completion.",
            "nullable":true,
            "x-queryable":false
        },
        "ObjectReferenceId":{
            "type":"integer",
            "description":"Reference identifier of the journey template object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "contacts":{
            "title":"Contacts",
            "type":"array",
            "description":"The contacts resource is a child of the journeys resource. It includes a list of contacts associated with the parent journey template.",
            "items":{
                "$ref":"#/components/schemas/journeys-contacts-item-patch-request"
            }
        },
        "events":{
            "title":"Events",
            "type":"array",
            "description":"The events resource is a child of the journeys resource. It includes all events associated with the parent journey template.",
            "items":{
                "$ref":"#/components/schemas/journeys-events-item-patch-request"
            }
        },
        "properties":{
            "title":"Properties",
            "type":"array",
            "description":"The properties resource is the child of the journeys resource. It includes all the journey properties associated with the parent journey template.",
            "items":{
                "$ref":"#/components/schemas/journeys-properties-item-patch-request"
            }
        },
        "tasks":{
            "title":"Tasks",
            "type":"array",
            "description":"The tasks resource is a child of the journeys resource. It includes all the tasks in the parent journey template.",
            "items":{
                "$ref":"#/components/schemas/journeys-tasks-item-patch-request"
            }
        },
        "ArchiveOffsetDays":{
            "title":"Archive After Months",
            "type":"integer",
            "description":"Number of days to consider for archiving journeys.",
            "format":"int32",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"3"
            }
        },
        "PurgeOffsetDays":{
            "title":"Purge After Months",
            "type":"integer",
            "description":"Number of days to consider for purging journeys.",
            "format":"int32",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"3"
            }
        }
    }
}

Nested Schema : All Step Tasks

Type: array

Title: All Step Tasks

The allStepTasks resource is a child of the journeys resource. It includes all the tasks in the parent journey template.

Show Source

• Array of: object journeys-allStepTasks-item-patch-request

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

Nested Schema : Contacts

Type: array

Title: Contacts

The contacts resource is a child of the journeys resource. It includes a list of contacts associated with the parent journey template.

Show Source

• Array of: object journeys-contacts-item-patch-request

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

Nested Schema : Events

Type: array

Title: Events

The events resource is a child of the journeys resource. It includes all events associated with the parent journey template.

Show Source

• Array of: object journeys-events-item-patch-request

{
    "title":"Events",
    "type":"array",
    "description":"The events resource is a child of the journeys resource. It includes all events associated with the parent journey template.",
    "items":{
        "$ref":"#/components/schemas/journeys-events-item-patch-request"
    }
}

Nested Schema : Notes

Type: array

Title: Notes

The notes resource is a child of the journeys resource. It includes all the notes associated with the parent journey template.

Show Source

• Array of: object journeys-notes-item-patch-request

{
    "title":"Notes",
    "type":"array",
    "description":"The notes resource is a child of the journeys resource. It includes all the notes associated with the parent journey template.",
    "items":{
        "$ref":"#/components/schemas/journeys-notes-item-patch-request"
    }
}

Nested Schema : Properties

Type: array

Title: Properties

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

Show Source

• Array of: object schema

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

Nested Schema : Tasks

Type: array

Title: Tasks

The tasks resource is a child of the journeys resource. It includes all the tasks in the parent journey template.

Show Source

• Array of: object journeys-tasks-item-patch-request

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

Nested Schema : Task Types

Type: array

Title: Task Types

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

Show Source

• Array of: object schema

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

Nested Schema : journeys-allStepTasks-item-patch-request

Type: object

Show Source

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

Nested Schema : journeys-contacts-item-patch-request

Type: object

Show Source

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

Nested Schema : journeys-events-item-patch-request

Type: object

Show Source

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

Nested Schema : journeys-notes-item-patch-request

Type: object

Show Source

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

Nested Schema : schema

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 group for journey template property.
• Code: string
  Code of the property in the journey template.
• 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
  Property level for the journey template.
• LineManagerDefaultValue: string
  Default value of the journey template property for line manager.
• LineManagerLookupType: string
  Line Manager type for the journey template property.
• LineManagerValue: string
  Value of the journey template property for assignee.
• 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.
• Sequence: integer
  Sequence of the journey template property.

{
    "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
            }
        },
        "Sequence":{
            "type":"integer",
            "description":"Sequence of the journey template property.",
            "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 property in the journey template.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "CategoryMeaning":{
            "type":"string",
            "description":"Meaning of 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
            }
        },
        "Level":{
            "type":"string",
            "description":"Property level for the journey template.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "LineManagerLookupType":{
            "type":"string",
            "description":"Line Manager type for the journey template property.",
            "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 : journeys-tasks-item-patch-request

Type: object

Show Source

• ActionAddToCalendarLabel: string
  Maximum Length: 120

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

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

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

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

  Maximum Length: 1000

  The URL associated with the task that's entered on the setup screen. To retrieve a navigable URL, use the getNavigationURL custom method of the resource.
• 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.
• AllowAttachmentFlag: boolean
  Indicates whether attachments can be added to the task. Valid values are Yes or No. The default is No.
• AllowCommentFlag: boolean
  Indicates whether comments can be added to the task. Valid values are Yes or No. The default is No.
• AllowNotesContentFlag: boolean
  Indicates whether rich content can be added for notes. Valid values are Yes or No. The default is Yes.
• AttachmentDocumentTypeId: integer (int64)
  Description for the AttachmentDocumentTypeId attribute in the tasks resource, which is part of the journeys root resource.
• ContactUserId: integer
  User ID of the task performer.
• ContactUserIdentifier: string
  Maximum Length: 64

  Internal identifier of the journey task performer.
• ContentProviderCode: string
  Maximum Length: 240

  Code of the user-defined content task.
• DependentTaskCode: string
  Maximum Length: 240

  Code of the dependent task.
• DependentTaskId: integer (int64)
  Primary key or unique identifier of the dependent task.
• Description: string
  Title: Description

  Maximum Length: 4000

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

  The attachments resource is used to view, create, and update attachments.
• EnableExpiryFlag: boolean
  Maximum Length: 4

  Indicates whether the task should expire. Valid values are Yes and No. The default value is No.
• ExpiryDuration: integer (int32)
  Title: Expiry Days

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

  Criteria based on which the task expires.
• 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.
• Name: string
  Title: Task Name

  Maximum Length: 240

  Name of the journey task.
• Notes: string (byte)
  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.
• 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 existing page or a new page. Valid values are Yes and No. The default value is Yes.
• OwnerPersonId: integer (int64)
  Internal identifier of the journey task owner.
• OwnerResponsibilityType: string
  Responsibility type of the journey task owner.
• OwnerType: string
  Maximum Length: 30

  Default Value: ORA_CHK_INITIATOR

  Task owner type.
• OwnerUserGroupCode: string
  Code of the owner user group.
• PerformerPersonId: integer (int64)
  Internal identifier of the journey task performer.
• PerformerResponsibilityType: string
  Responsibility type of the journey task performer.
• PerformerType: string
  Title: Responsibility Type

  Maximum Length: 30

  Default Value: ORA_WORKER

  Task performer type.
• PerformerUserGroupCode: string
  Code of the performer user group.
• properties: array Properties
  Title: Properties

  The properties resource is the child of the journeys resource. It includes all the journey properties associated with the parent journey template.
• ReminderDuration: integer (int32)
  Duration of the task reminder.
• ReminderRecurrence: string
  Maximum Length: 30

  Recurrence of the reminder.
• ReminderRelativeTo: string
  Maximum Length: 30

  Default Value: ORA_CHK_BFR_DUE_DT

  Reminder relative to task duration.
• ReminderTemplateId: integer (int64)
  Primary key or unique identifier of the reminder notification template.
• RequiredFlag: boolean
  Title: Required

  Maximum Length: 30

  Default Value: false

  Indicates whether the task is mandatory or optional. Valid values are Yes and No. Default is No.
• SaveAttachmentsToDORFor: string
  Document records of person for whom to save task attachments.
• Sequence: integer (int32)
  Default Value: 1

  Task display ordering sequence. Default is 1.
• SubType: string
  Title: Signature Type

  Maximum Length: 30

  Task action subtype code. Available only for action types I-9 and Electronic Signature.
• TargetDuration: integer (int32)
  Title: Target Duration

  Target duration for the task.
• TargetDurationUOM: string
  Title: UOM

  Maximum Length: 30

  Unit of measure for the target duration.
• Type: string
  Title: Task Type

  Maximum Length: 30

  Default Value: ORA_CHK_MANUAL

  Task action type code.

{
    "type":"object",
    "properties":{
        "ContentProviderCode":{
            "maxLength":"240",
            "type":"string",
            "description":"Code of the user-defined content task.",
            "nullable":true,
            "x-queryable":false
        },
        "documents":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/journeys-tasks-documents-item-patch-request"
            }
        },
        "ActionSaveLabel":{
            "maxLength":"120",
            "type":"string",
            "description":"Setting that enables to change the label of the save as draft action.",
            "nullable":true,
            "x-queryable":false
        },
        "ContactUserIdentifier":{
            "maxLength":"64",
            "type":"string",
            "description":"Internal identifier of the journey task performer.",
            "nullable":true,
            "x-queryable":false
        },
        "ActionRejectLabel":{
            "maxLength":"120",
            "type":"string",
            "description":"Setting that enables to change the label of the not applicable action.",
            "nullable":true,
            "x-queryable":false
        },
        "Name":{
            "title":"Task Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the journey task.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ActivityAction1Label":{
            "maxLength":"120",
            "type":"string",
            "description":"Setting that enables to change the label of action 1.",
            "nullable":true,
            "x-queryable":false
        },
        "OwnerType":{
            "maxLength":"30",
            "type":"string",
            "description":"Task owner type.",
            "nullable":true,
            "default":"ORA_CHK_INITIATOR",
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            }
        },
        "AllowAttachmentFlag":{
            "type":"boolean",
            "description":"Indicates whether attachments can be added to the task. Valid values are Yes or No. The default is No.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "DependentTaskCode":{
            "maxLength":"240",
            "type":"string",
            "description":"Code of the dependent task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LearnCommunityId":{
            "type":"integer",
            "description":"Identifier of the learning community.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "LearnEnrollmentId":{
            "type":"integer",
            "description":"Identifier of the learning enrollment.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "DependentTaskId":{
            "type":"integer",
            "description":"Primary key or unique identifier of the dependent task.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18",
                "sortable":false
            }
        },
        "SubType":{
            "title":"Signature Type",
            "maxLength":"30",
            "type":"string",
            "description":"Task action subtype code. Available only for action types I-9 and Electronic Signature.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ContactUserId":{
            "type":"integer",
            "description":"User ID of the task performer.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "PerformerPersonId":{
            "type":"integer",
            "description":"Internal identifier of the journey task performer.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ReminderTemplateId":{
            "type":"integer",
            "description":"Primary key or unique identifier of the reminder notification template.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "Sequence":{
            "type":"integer",
            "description":"Task display ordering sequence. Default is 1.",
            "format":"int32",
            "nullable":true,
            "default":"1",
            "x-queryable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "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
            }
        },
        "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
            }
        },
        "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/journeys-tasks-notifications-item-patch-request"
            }
        },
        "TargetDuration":{
            "title":"Target Duration",
            "type":"integer",
            "description":"Target duration for the task.",
            "format":"int32",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"9"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"4000",
            "type":"string",
            "description":"Description of the task.",
            "nullable":true,
            "x-queryable":false
        },
        "PerformerUserGroupCode":{
            "type":"string",
            "description":"Code of the performer user group.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "SaveAttachmentsToDORFor":{
            "type":"string",
            "description":"Document records of person for whom to save task attachments.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "OwnerResponsibilityType":{
            "type":"string",
            "description":"Responsibility type of the journey task owner.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "sortable":false
            }
        },
        "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
        },
        "ExpiryRelativeTo":{
            "maxLength":"30",
            "type":"string",
            "description":"Criteria based on which the task expires.",
            "nullable":true,
            "x-queryable":false
        },
        "AllowCommentFlag":{
            "type":"boolean",
            "description":"Indicates whether comments can be added to the task. Valid values are Yes or No. The default is No.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ActionAddToCalendarLabel":{
            "maxLength":"120",
            "type":"string",
            "description":"Setting that enables to change the label of the add to calendar action.",
            "nullable":true,
            "x-queryable":false
        },
        "ActivityAction4Label":{
            "maxLength":"120",
            "type":"string",
            "description":"Setting that enables to change the label of action 4.",
            "nullable":true,
            "x-queryable":false
        },
        "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
        },
        "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
        },
        "TargetDurationUOM":{
            "title":"UOM",
            "maxLength":"30",
            "type":"string",
            "description":"Unit of measure for the target duration.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            }
        },
        "ExpiryDuration":{
            "title":"Expiry Days",
            "type":"integer",
            "description":"Duration after which the task expires.",
            "format":"int32",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"5"
            }
        },
        "PerformerResponsibilityType":{
            "type":"string",
            "description":"Responsibility type of the journey task performer.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "sortable":false
            }
        },
        "AttachmentDocumentTypeId":{
            "type":"integer",
            "description":"Description for the AttachmentDocumentTypeId attribute in the tasks resource, which is part of the journeys root resource.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "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":"Responsibility Type",
            "maxLength":"30",
            "type":"string",
            "description":"Task performer type.",
            "nullable":true,
            "default":"ORA_WORKER",
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            }
        },
        "ReminderRelativeTo":{
            "maxLength":"30",
            "type":"string",
            "description":"Reminder relative to task duration.",
            "nullable":true,
            "default":"ORA_CHK_BFR_DUE_DT",
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OwnerUserGroupCode":{
            "type":"string",
            "description":"Code of the owner user group.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "Type":{
            "title":"Task Type",
            "maxLength":"30",
            "type":"string",
            "description":"Task action type code.",
            "nullable":false,
            "default":"ORA_CHK_MANUAL",
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            }
        },
        "ReminderDuration":{
            "type":"integer",
            "description":"Duration of the task reminder.",
            "format":"int32",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"3"
            }
        },
        "ReminderRecurrence":{
            "maxLength":"30",
            "type":"string",
            "description":"Recurrence of the reminder.",
            "nullable":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,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "RequiredFlag":{
            "title":"Required",
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates whether the task is mandatory or optional. Valid values are Yes and No. Default is No.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ActionURL":{
            "title":"URL",
            "maxLength":"1000",
            "type":"string",
            "description":"The URL associated with the task that's entered on the setup screen. To retrieve a navigable URL, use the getNavigationURL custom method of the resource.",
            "nullable":true,
            "x-queryable":false
        },
        "OwnerPersonId":{
            "type":"integer",
            "description":"Internal identifier of the journey task owner.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "properties":{
            "title":"Properties",
            "type":"array",
            "description":"The properties resource is the child of the journeys resource. It includes all the journey properties associated with the parent journey template.",
            "items":{
                "$ref":"#/components/schemas/journeys-tasks-properties-item-patch-request"
            }
        },
        "ActionCompleteLabel":{
            "maxLength":"120",
            "type":"string",
            "description":"Setting that enables to change the label of the complete action.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

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

Show Source

• Array of: object journeys-tasks-documents-item-patch-request

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

Nested Schema : Notifications

Type: array

Title: Notifications

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

Show Source

• Array of: object journeys-tasks-notifications-item-patch-request

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

Nested Schema : Properties

Type: array

Title: Properties

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

Show Source

• Array of: object journeys-tasks-properties-item-patch-request

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

Nested Schema : journeys-tasks-documents-item-patch-request

Type: object

Show Source

• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• DownloadInfo: string
  Title: DownloadInfo

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

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

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

  Maximum Length: 2048

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

  The URI of the file.
• PostProcessingAction: string
  Title: PostProcessingAction

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

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

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

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.

{
    "type":"object",
    "properties":{
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        }
    }
}

Nested Schema : journeys-tasks-notifications-item-patch-request

Type: object

Show Source

• NotifyOwnerFlag: boolean
  Maximum Length: 30

  Indicates if the task owner needs to be notified when the event occurs. Valid values are Yes and No. Default is No.
• NotifyPerformerFlag: boolean
  Maximum Length: 30

  Indicates if the task performer needs to be notified when the event occurs. Valid values are Yes and No. Default is Yes.
• OwnerExpiryTemplateId: integer (int64)
  Primary key or unique identifier of the expiry notification template for task owner.
• OwnerForceCompleteTemplateId: integer (int64)
  Primary key or unique identifier of the force completion notification template for task owner.
• OwnerNotApplicableTemplateId: integer (int64)
  Primary key or unique identifier of the notification template when a task is marked as not applicable for task owner.
• OwnerTemplateId: integer (int64)
  Primary key or unique identifier of the notification template for task owner.
• PerformerExpiryTemplateId: integer (int64)
  Primary key or unique identifier of the expiry notification template for task performer.
• PerformerForceCompleteTemplateId: integer (int64)
  Primary key or unique identifier of the force completion notification template for task performer.
• PerformerNotApplicableTemplateId: integer (int64)
  Primary key or unique identifier of the notification template when a task is marked as not applicable for task performer.
• PerformerTemplateId: integer (int64)
  Primary key or unique identifier of the notification template for task performer.

{
    "type":"object",
    "properties":{
        "PerformerExpiryTemplateId":{
            "type":"integer",
            "description":"Primary key or unique identifier of the expiry notification template for task performer.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "NotifyPerformerFlag":{
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates if the task performer needs to be notified when the event occurs. Valid values are Yes and No. Default is Yes.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "OwnerNotApplicableTemplateId":{
            "type":"integer",
            "description":"Primary key or unique identifier of the notification template when a task is marked as not applicable for task owner.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "OwnerForceCompleteTemplateId":{
            "type":"integer",
            "description":"Primary key or unique identifier of the force completion notification template for task owner.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "NotifyOwnerFlag":{
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates if the task owner needs to be notified when the event occurs. Valid values are Yes and No. Default is No.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "PerformerTemplateId":{
            "type":"integer",
            "description":"Primary key or unique identifier of the notification template for task performer.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "OwnerTemplateId":{
            "type":"integer",
            "description":"Primary key or unique identifier of the notification template for task owner.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "OwnerExpiryTemplateId":{
            "type":"integer",
            "description":"Primary key or unique identifier of the expiry notification template for task owner.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PerformerForceCompleteTemplateId":{
            "type":"integer",
            "description":"Primary key or unique identifier of the force completion notification template for task performer.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PerformerNotApplicableTemplateId":{
            "type":"integer",
            "description":"Primary key or unique identifier of the notification template when a task is marked as not applicable for task performer.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

Nested Schema : journeys-tasks-properties-item-patch-request

Type: object

Show Source

• Category: string
  Name of the group for journey template task property.
• CategoryMeaning: string
  Meaning of the group for journey template task property.
• Code: string
  Code of the journey template task property.
• DisabledForLineManagerFlag: boolean
  Indicates if the 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 type for line manager.
• LineManagerValue: string
  Value of the journey template task property for line manager.
• 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
  Value of the journey template task property 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
  Value of the journey template task property for owner.
• PerformerDefaultValue: string
  Default value of the journey template task property for performer.
• PerformerLookupType: string
  Journey template task property type for performer.
• PerformerValue: string
  Value of the journey template task property 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":"Value of the journey template task property 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":"Code of the journey template task property.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "CategoryMeaning":{
            "type":"string",
            "description":"Meaning of the 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":"Value of the journey template task property 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 the 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
            }
        },
        "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 type for performer.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "LineManagerLookupType":{
            "type":"string",
            "description":"Journey template task property type for line manager.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "OwnerValue":{
            "type":"string",
            "description":"Value of the journey template task property 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 : schema

Type: object

Show Source

• Code: string
  Maximum Length: 61

  Code of the journey template task type property.
• JourneyId: integer
  Identifier of the journey template task type property.
• properties: array Properties
  Title: Properties

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

{
    "type":"object",
    "properties":{
        "Code":{
            "maxLength":"61",
            "type":"string",
            "description":"Code of the journey template task type property.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "JourneyId":{
            "type":"integer",
            "description":"Identifier of the journey template task type property.",
            "nullable":true
        },
        "properties":{
            "title":"Properties",
            "type":"array",
            "description":"The properties resource is the child of the journeys resource. It includes all the journey properties associated with the parent journey template.",
            "items":{
                "$ref":"#/components/schemas/journeys-taskTypes-properties-item-patch-request"
            }
        }
    }
}

Nested Schema : Properties

Type: array

Title: Properties

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

Show Source

• Array of: object journeys-taskTypes-properties-item-patch-request

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

Nested Schema : journeys-taskTypes-properties-item-patch-request

Type: object

Show Source

• Category: string
  Category of the journey template task type property.
• CategoryMeaning: string
  Meaning of category 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.
• 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":"Category of the 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
            }
        },
        "CategoryMeaning":{
            "type":"string",
            "description":"Meaning of category 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
            }
        },
        "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
            }
        }
    }
}

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

Type: object

Show Source

• AllocationCriteria: string
  Title: Allocation Criteria

  Maximum Length: 30

  Default Value: ORA_CHK_ALLOCATION_DT

  Criteria to determine journey assignment.
• AllocationCriteriaMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Meaning of assignment criteria.
• AllocationOffsetDays: integer (int32)
  Title: Days for Initiation

  Default Value: 0

  Number of days to consider for initiating journey assignment.
• AllowAssignToDirectsFlag: boolean
  Read Only: true

  Indicates whether journey can be assigned to direct reports.
• AllowAssignToOrganizationFlag: boolean
  Read Only: true

  Indicates whether the journey can be assigned to employees in an organization.
• AllowAssignToPersonFlag: boolean
  Read Only: true

  Indicates whether journey can be assigned to direct reports.
• AllowAssignToSelfFlag: boolean
  Read Only: true

  Indicates whether journey can be assigned to direct reports.
• allStepTasks: array All Step Tasks
  Title: All Step Tasks

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

  Number of days to consider for archiving journeys.
• AssignedFeedFlag: boolean
  Read Only: true

  Indicates whether the atom feed is enabled when a journey is assigned.
• AssignedTemplateId: integer (int64)
  Primary key or unique identifier of the assigned notification template.
• BackgroundImage: string (byte)
  Background image displayed on the journey page.
• BackgroundImageFileName: string
  Maximum Length: 2048

  File name of the background image.
• BackgroundImageSource: string
  Read Only: true

  Source of the background image.
• BackgroundImageURL: string
  Maximum Length: 4000

  URL of the image displayed on the journey details page.
• BackgroundThumbnailURL: string
  Maximum Length: 4000

  URL of the image displayed on the journey card.
• Category: string
  Title: Category

  Maximum Length: 60

  Category code for the event. Values are from ORA_PER_ONB_CONTENT_SBTYP_EVNT lookup. For example, Insight.
• CategoryMeaning: string
  Read Only: true

  Maximum Length: 120

  Meaning of the journey category.
• Code: string
  Read Only: true

  Maximum Length: 240

  Code for the journey template.
• CombinedNotificationTemplateId: integer (int64)
  Primary key or unique identifier of the combined notification template.
• CompletedFeedFlag: boolean
  Read Only: true

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

  Maximum Length: 30

  Default Value: ORA_CHK_MAND_TASK_COMPLETE

  Completion criteria to complete a journey.
• CompletionCriteriaMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Meaning of completion criteria.
• CompletionMessage: string
  Maximum Length: 720

  Message displayed on journey completion.
• CompletionOffsetDays: integer (int32)
  Title: Days for Completion

  Default Value: 0

  Number of offset days to consider for journey completion.
• contacts: array Contacts
  Title: Contacts

  The contacts resource is a child of the journeys resource. It includes a list of contacts associated with the parent journey template.
• Context: string
  Read Only: true

  Maximum Length: 240

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

  Maximum Length: 240

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

  Read Only: true

  Maximum Length: 80

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

  Maximum Length: 30

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

  Maximum Length: 64

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

  Date on which the journey template was created.
• CroppedBackgroundImage: string (byte)
  Cropped background image displayed on the journey page.
• DateFrom: string (date)
  Read Only: true

  Date from which the journey template is active.
• DateTo: string (date)
  Read Only: true

  Date until which the journey template is active.
• DeletedFeedFlag: boolean
  Read Only: true

  Indicates whether the atom feed is enabled when a journey is deleted.
• Description: string
  Title: Description

  Maximum Length: 360

  Description of the task.
• DisplayFeatures: string
  Display features of a journey template.
• DisplayNameFormat: string
  Maximum Length: 240

  Display name format of a journey template.
• events: array Events
  Title: Events

  The events resource is a child of the journeys resource. It includes all events associated with the parent journey template.
• FavouriteFlag: boolean
  Read Only: true

  Maximum Length: 4

  Indicates whether the journey is marked as a favorite.
• FeedFlag: boolean
  Read Only: true

  Indicates whether the atom feed is enabled.
• ForceCompletedTemplateId: integer (int64)
  Primary key or unique identifier of the force completion notification template.
• InitiatedFeedFlag: boolean
  Read Only: true

  Indicates whether the atom feed is enabled when a journey is initiated.
• JourneyId: integer (int64)
  Read Only: true

  Primary key of the journey template.
• JourneyTitle: string
  Read Only: true

  Title of the journey template.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

  User who last updated the journey template.
• Level: string
  Read Only: true

  Maximum Length: 30

  Default Value: ORA_PERSONAL

  Level of a journey template.
• LevelMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Meaning of journey template level.
• LevelValue: integer (int64)
  Read Only: true

  Default Value: 0

  Value of journey template level such as global or personal.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MessageSubTitle: string
  Maximum Length: 720

  Subtitle of the message displayed in the journey details.
• MessageText: string
  Maximum Length: 400

  Message text displayed for a journey.
• MessageTitle: string
  Maximum Length: 400

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

  Maximum Length: 240

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

  The notes resource is a child of the journeys resource. It includes all the notes associated with the parent journey template.
• ObjectReferenceId: integer (int64)
  Reference identifier of the journey template object.
• ProcessingMode: string
  Maximum Length: 30

  Processing mode to send journey notifications.
• properties: array Properties
  Title: Properties

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

  Number of days to consider for purging journeys.
• RawBackgroundImageURL: string
  Maximum Length: 4000

  URL of the original background image.
• RecurrentScheduleAllowedFlag: boolean
  Read Only: true

  Maximum Length: 4

  Default Value: false

  Indicates whether journey recurrence is scheduled.
• Status: string
  Title: Status

  Read Only: true

  Maximum Length: 30

  Default Value: ORA_CHK_ACTIVE

  Code for the task status.
• StatusMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Status of the task.
• SubCategory: string
  Maximum Length: 60

  Subcategory of the worker journey.
• SubCategoryMeaning: string
  Read Only: true

  Maximum Length: 120

  Subcategory meaning of the worker journey.
• SubjectType: string
  Maximum Length: 240

  Default Value: P

  Type of the subject of the journey template.
• tasks: array Tasks
  Title: Tasks

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

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

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date on which the journey template 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 journeys resource. It includes all the notes associated with the parent journey template.",
            "items":{
                "$ref":"#/components/schemas/journeys-notes-item-response"
            }
        },
        "AllocationOffsetDays":{
            "title":"Days for Initiation",
            "type":"integer",
            "description":"Number of days to consider for initiating journey assignment.",
            "format":"int32",
            "nullable":true,
            "default":"0",
            "x-queryable":false,
            "x-hints":{
                "precision":"5"
            }
        },
        "ProcessingMode":{
            "maxLength":"30",
            "type":"string",
            "description":"Processing mode to send journey notifications.",
            "nullable":true,
            "x-queryable":false
        },
        "CompletionCriteria":{
            "title":"Completion Criteria",
            "maxLength":"30",
            "type":"string",
            "description":"Completion criteria to complete a journey.",
            "nullable":true,
            "default":"ORA_CHK_MAND_TASK_COMPLETE",
            "x-queryable":false
        },
        "LevelMeaning":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of journey template level.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the journey task.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SubjectType":{
            "maxLength":"240",
            "type":"string",
            "description":"Type of the subject of the journey template.",
            "nullable":false,
            "default":"P",
            "x-queryable":true
        },
        "CompletionCriteriaMeaning":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of completion criteria.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FavouriteFlag":{
            "maxLength":"4",
            "type":"boolean",
            "description":"Indicates whether the journey is marked as a favorite.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AllowAssignToSelfFlag":{
            "type":"boolean",
            "description":"Indicates whether journey can be assigned to direct reports.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AllowAssignToOrganizationFlag":{
            "type":"boolean",
            "description":"Indicates whether the journey can be assigned to employees in an organization.",
            "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"
            }
        },
        "CompletionOffsetDays":{
            "title":"Days for Completion",
            "type":"integer",
            "description":"Number of offset days to consider for journey completion.",
            "format":"int32",
            "nullable":true,
            "default":"0",
            "x-queryable":false,
            "x-hints":{
                "precision":"5"
            }
        },
        "DeletedFeedFlag":{
            "type":"boolean",
            "description":"Indicates whether the atom feed is enabled when a journey is deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "AssignedTemplateId":{
            "type":"integer",
            "description":"Primary key or unique identifier of the assigned notification template.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "events":{
            "title":"Events",
            "type":"array",
            "description":"The events resource is a child of the journeys resource. It includes all events associated with the parent journey template.",
            "items":{
                "$ref":"#/components/schemas/journeys-events-item-response"
            }
        },
        "tasks":{
            "title":"Tasks",
            "type":"array",
            "description":"The tasks resource is a child of the journeys resource. It includes all the tasks in the parent journey template.",
            "items":{
                "$ref":"#/components/schemas/journeys-tasks-item-response"
            }
        },
        "ArchiveOffsetDays":{
            "title":"Archive After Months",
            "type":"integer",
            "description":"Number of days to consider for archiving journeys.",
            "format":"int32",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"3"
            }
        },
        "PurgeOffsetDays":{
            "title":"Purge After Months",
            "type":"integer",
            "description":"Number of days to consider for purging journeys.",
            "format":"int32",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"3"
            }
        },
        "Status":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"Code for the task status.",
            "nullable":true,
            "readOnly":true,
            "default":"ORA_CHK_ACTIVE",
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who last updated the journey template.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "BackgroundImageURL":{
            "maxLength":"4000",
            "type":"string",
            "description":"URL of the image displayed on the journey details page.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the journey template.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "DisplayNameFormat":{
            "maxLength":"240",
            "type":"string",
            "description":"Display name format of a journey template.",
            "nullable":true,
            "x-queryable":false
        },
        "FeedFlag":{
            "type":"boolean",
            "description":"Indicates whether the atom feed is enabled.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "RecurrentScheduleAllowedFlag":{
            "maxLength":"4",
            "type":"boolean",
            "description":"Indicates whether journey recurrence is scheduled.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":false
        },
        "CroppedBackgroundImage":{
            "type":"string",
            "description":"Cropped background image displayed on the journey page.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "BackgroundImageContentId"
                ]
            }
        },
        "CategoryMeaning":{
            "maxLength":"120",
            "type":"string",
            "description":"Meaning of the journey category.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Code":{
            "maxLength":"240",
            "type":"string",
            "description":"Code for the journey template.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "RawBackgroundImageURL":{
            "maxLength":"4000",
            "type":"string",
            "description":"URL of the original background image.",
            "nullable":true,
            "x-queryable":false
        },
        "JourneyId":{
            "type":"integer",
            "description":"Primary key of the journey template.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "MessageTitle":{
            "maxLength":"400",
            "type":"string",
            "description":"Title of the message displayed in the journey details.",
            "nullable":true,
            "x-queryable":false
        },
        "BackgroundImage":{
            "type":"string",
            "description":"Background image displayed on the journey page.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "RawImageContentId"
                ]
            }
        },
        "DateFrom":{
            "type":"string",
            "description":"Date from which the journey template is active.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Country":{
            "title":"Territory Name",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the country for which the journey template is applicable.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Level":{
            "maxLength":"30",
            "type":"string",
            "description":"Level of a journey template.",
            "nullable":true,
            "readOnly":true,
            "default":"ORA_PERSONAL",
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CompletionMessage":{
            "maxLength":"720",
            "type":"string",
            "description":"Message displayed on journey completion.",
            "nullable":true,
            "x-queryable":false
        },
        "BackgroundImageFileName":{
            "maxLength":"2048",
            "type":"string",
            "description":"File name of the background image.",
            "nullable":true,
            "x-queryable":false
        },
        "allStepTasks":{
            "title":"All Step Tasks",
            "type":"array",
            "description":"The allStepTasks resource is a child of the journeys resource. It includes all the tasks in the parent journey template.",
            "items":{
                "$ref":"#/components/schemas/journeys-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",
            "maxLength":"60",
            "type":"string",
            "description":"Category code for the event. Values are from ORA_PER_ONB_CONTENT_SBTYP_EVNT lookup. For example, Insight.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"360",
            "type":"string",
            "description":"Description of the task.",
            "nullable":true,
            "x-queryable":false
        },
        "SubCategoryMeaning":{
            "maxLength":"120",
            "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,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "BackgroundThumbnailURL":{
            "maxLength":"4000",
            "type":"string",
            "description":"URL of the image displayed on the journey card.",
            "nullable":true,
            "x-queryable":false
        },
        "LevelValue":{
            "type":"integer",
            "description":"Value of journey template level such as global or personal.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "default":"0",
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "AllowAssignToDirectsFlag":{
            "type":"boolean",
            "description":"Indicates whether journey can be assigned to direct reports.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AllowAssignToPersonFlag":{
            "type":"boolean",
            "description":"Indicates whether journey can be assigned to direct reports.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "taskTypes":{
            "title":"Task Types",
            "type":"array",
            "description":"The taskTypes resource is the child of the journeys resource. It includes all the task types associated with the parent journey template.",
            "items":{
                "$ref":"#/components/schemas/journeys-taskTypes-item-response"
            }
        },
        "ContextualAction":{
            "maxLength":"240",
            "type":"string",
            "description":"Transaction flow for which the contextual journey template is applicable.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CountryCode":{
            "title":"Legislation Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code of the country for which the journey template is applicable.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "MessageSubTitle":{
            "maxLength":"720",
            "type":"string",
            "description":"Subtitle of the message displayed in the journey details.",
            "nullable":true,
            "x-queryable":false
        },
        "ObjectReferenceId":{
            "type":"integer",
            "description":"Reference identifier of the journey template object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Context":{
            "maxLength":"240",
            "type":"string",
            "description":"Context for a journey.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedFeedFlag":{
            "type":"boolean",
            "description":"Indicates whether the atom feed is enabled when a journey is assigned.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "MessageText":{
            "maxLength":"400",
            "type":"string",
            "description":"Message text displayed for a journey.",
            "nullable":true,
            "x-queryable":false
        },
        "StatusMeaning":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Status of the task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "AllocationCriteriaMeaning":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of assignment criteria.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AllocationCriteria":{
            "title":"Allocation Criteria",
            "maxLength":"30",
            "type":"string",
            "description":"Criteria to determine journey assignment.",
            "nullable":true,
            "default":"ORA_CHK_ALLOCATION_DT",
            "x-queryable":false
        },
        "ForceCompletedTemplateId":{
            "type":"integer",
            "description":"Primary key or unique identifier of the force completion notification template.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "CombinedNotificationTemplateId":{
            "type":"integer",
            "description":"Primary key or unique identifier of the combined notification template.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "JourneyTitle":{
            "type":"string",
            "description":"Title of the journey template.",
            "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,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "SubCategory":{
            "maxLength":"60",
            "type":"string",
            "description":"Subcategory of the worker journey.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DisplayFeatures":{
            "type":"string",
            "description":"Display features of a journey template.",
            "nullable":true,
            "x-queryable":false
        },
        "contacts":{
            "title":"Contacts",
            "type":"array",
            "description":"The contacts resource is a child of the journeys resource. It includes a list of contacts associated with the parent journey template.",
            "items":{
                "$ref":"#/components/schemas/journeys-contacts-item-response"
            }
        },
        "properties":{
            "title":"Properties",
            "type":"array",
            "description":"The properties resource is the child of the journeys resource. It includes all the journey properties associated with the parent journey template.",
            "items":{
                "$ref":"#/components/schemas/journeys-properties-item-response"
            }
        },
        "DateTo":{
            "type":"string",
            "description":"Date until which the journey template is active.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date on which the journey template 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 journeys resource. It includes all the tasks in the parent journey template.

Show Source

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

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

Nested Schema : Contacts

Type: array

Title: Contacts

The contacts resource is a child of the journeys resource. It includes a list of contacts associated with the parent journey template.

Show Source

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

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

Nested Schema : Events

Type: array

Title: Events

The events resource is a child of the journeys resource. It includes all events associated with the parent journey template.

Show Source

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

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

Show Source

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

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

Nested Schema : Properties

Type: array

Title: Properties

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

Show Source

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

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

Nested Schema : Tasks

Type: array

Title: Tasks

The tasks resource is a child of the journeys resource. It includes all the tasks in the parent journey template.

Show Source

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

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

Nested Schema : Task Types

Type: array

Title: Task Types

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

Show Source

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

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

Nested Schema : journeys-allStepTasks-item-response

Type: object

Show Source

• ActionURL: string
  Read Only: true

  Maximum Length: 1000

  The URL associated with the task that's entered on the setup screen. To retrieve a navigable URL, use the getNavigationURL custom method of the resource.
• AllowAttachmentFlag: boolean
  Read Only: true

  Indicates whether attachments can be added to the task. Valid values are Yes or No. The default is No.
• AllowCommentFlag: boolean
  Read Only: true

  Indicates whether comments can be added to the task. Valid values are Yes or No. The default 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
  Read Only: true

  Indicates whether the Notes title can be added. Valid values are Yes or No. The default is No.
• DelayDuration: integer (int32)
  Read Only: true

  Delay duration for the task.
• DelayDurationUOM: string
  Read Only: true

  Maximum Length: 30

  Unit of measure used in specifying delaying the duration.
• DelayDurationUOMMeaning: string
  Read Only: true

  Maximum Length: 80

  Meaning of unit of measure used in delay duration.
• DependentTaskId: integer (int64)
  Read Only: true

  Primary key or unique identifier of the dependent task.
• DependentTaskName: string
  Read Only: true

  Maximum Length: 240

  Name of the dependent task.
• Description: string
  Read Only: true

  Maximum Length: 4000

  Description of the task.
• JourneyTaskId: integer (int64)
  Read Only: true

  Unique identifier of the journey task.
• links: array Links
  Title: Links

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

  Maximum Length: 240

  Name of the journey task.
• Notes: string (byte)
  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
  Read Only: true

  Maximum Length: 150

  Title of the notes.
• 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.
• OwnerType: string
  Read Only: true

  Maximum Length: 30

  Task owner type.
• OwnerTypeMeaning: string
  Read Only: true

  Maximum Length: 80

  Task owner type meaning.
• ParentJourneyId: integer (int64)
  Read Only: true

  Identifier of the parent journey. In case of enterprise onboarding checklist this will point to the enterprise onboarding checklist in other cases it will be null.
• ParentJourneyName: string
  Read Only: true

  Maximum Length: 240

  Name of the parent journey template.
• PerformerType: string
  Read Only: true

  Maximum Length: 30

  Task performer type.
• PerformerTypeMeaning: string
  Read Only: true

  Maximum Length: 80

  Task performer type meaning.
• QuestionnaireId: integer (int64)
  Read Only: true

  Internal identifier of the questionnaire.
• RequiredFlag: boolean
  Read Only: true

  Maximum Length: 30

  Indicates whether the task is mandatory or optional. Valid values are Yes and No. Default is No.
• Sequence: number
  Read Only: true

  Task display ordering sequence. Default is 1.
• StageId: integer (int64)
  Read Only: true

  Unique identifier of the journey step.
• StageName: string
  Read Only: true

  Maximum Length: 240

  Name of the journey step.
• StageSequence: number
  Read Only: true

  Sequence of the journey step.
• Status: string
  Read Only: true

  Maximum Length: 30

  Code for the task status.
• StatusMeaning: string
  Read Only: true

  Maximum Length: 80

  Status of the task.
• SubType: string
  Read Only: true

  Maximum Length: 30

  Task action subtype code. Available only for action types I-9 and Electronic Signature.
• SubTypeMeaning: string
  Read Only: true

  Maximum Length: 80

  Task action subtype. Available only for action types I9 and Electronic Signature.
• TargetDuration: integer (int32)
  Read Only: true

  Target duration for the task.
• TargetDurationUOM: string
  Read Only: true

  Maximum Length: 30

  Unit of measure for the target duration.
• TargetDurationUOMMeaning: string
  Read Only: true

  Maximum Length: 80

  Meaning of the unit of measure used in the target duration.
• Type: string
  Read Only: true

  Maximum Length: 30

  Task action type code.
• TypeMeaning: string
  Read Only: true

  Maximum Length: 80

  Task action type.

{
    "type":"object",
    "properties":{
        "TargetDuration":{
            "type":"integer",
            "description":"Target duration for the task.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "Description":{
            "maxLength":"4000",
            "type":"string",
            "description":"Description of the task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StageId":{
            "type":"integer",
            "description":"Unique identifier of the journey step.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StageSequence":{
            "type":"number",
            "description":"Sequence of the journey step.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AllowNoteTitleFlag":{
            "type":"boolean",
            "description":"Indicates whether the Notes title can be added. Valid values are Yes or No. The default is No.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Name":{
            "maxLength":"240",
            "type":"string",
            "description":"Name of the journey task.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "AllowCommentFlag":{
            "type":"boolean",
            "description":"Indicates whether comments can be added to the task. Valid values are Yes or No. The default is No.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DelayDurationUOMMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of unit of measure used in delay duration.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OwnerType":{
            "maxLength":"30",
            "type":"string",
            "description":"Task owner type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "JourneyTaskId":{
            "type":"integer",
            "description":"Unique identifier of the journey task.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "SubTypeMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"Task action subtype. Available only for action types I9 and Electronic Signature.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DelayDurationUOM":{
            "maxLength":"30",
            "type":"string",
            "description":"Unit of measure used in specifying delaying the duration.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AllowAttachmentFlag":{
            "type":"boolean",
            "description":"Indicates whether attachments can be added to the task. Valid values are Yes or No. The default is No.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OwnerTypeMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"Task owner type meaning.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "QuestionnaireId":{
            "type":"integer",
            "description":"Internal identifier of the questionnaire.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"30"
            }
        },
        "PerformerTypeMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"Task performer type meaning.",
            "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"
            }
        },
        "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
        },
        "NoteTitle":{
            "maxLength":"150",
            "type":"string",
            "description":"Title of the notes.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Status":{
            "maxLength":"30",
            "type":"string",
            "description":"Code for the task status.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "TargetDurationUOM":{
            "maxLength":"30",
            "type":"string",
            "description":"Unit of measure for the target duration.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DependentTaskId":{
            "type":"integer",
            "description":"Primary key or unique identifier of the dependent task.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "SubType":{
            "maxLength":"30",
            "type":"string",
            "description":"Task action subtype code. Available only for action types I-9 and Electronic Signature.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "DependentTaskName":{
            "maxLength":"240",
            "type":"string",
            "description":"Name of the dependent task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StageName":{
            "maxLength":"240",
            "type":"string",
            "description":"Name of the journey step.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Sequence":{
            "type":"number",
            "description":"Task display ordering sequence. Default is 1.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PerformerType":{
            "maxLength":"30",
            "type":"string",
            "description":"Task performer type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ParentJourneyId":{
            "type":"integer",
            "description":"Identifier of the parent journey. In case of enterprise onboarding checklist this will point to the enterprise onboarding checklist in other cases it will be null.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "TypeMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"Task action type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ParentJourneyName":{
            "maxLength":"240",
            "type":"string",
            "description":"Name of the parent journey template.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"Status of the task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Type":{
            "maxLength":"30",
            "type":"string",
            "description":"Task action type code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "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
        },
        "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
        },
        "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
        },
        "RequiredFlag":{
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates whether the task is mandatory or optional. Valid values are Yes and No. Default is No.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "TargetDurationUOMMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of the unit of measure used in the target duration.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ActionURL":{
            "maxLength":"1000",
            "type":"string",
            "description":"The URL associated with the task that's entered on the setup screen. To retrieve a navigable URL, use the getNavigationURL custom method of the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DelayDuration":{
            "type":"integer",
            "description":"Delay duration for the task.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"9"
            }
        }
    }
}

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

Type: object

Show Source

• ContactPersonId: integer
  Internal identifier of the journey contact.
• ContactUser: string
  Maximum Length: 64

  User name of the journey contact.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date the contact was created.
• CustomContact: string
  Maximum Length: 400

  Custom contact details
• JourneyContactId: integer (int64)
  Read Only: true

  Unique identifier of the journey contact.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date the contact was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the contact.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ResponsibilityType: string
  Maximum Length: 30

  Responsibility type of the journey contact.
• ResponsibilityTypeMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Responsibility type meaning of the journey contact.
• Title: string
  Maximum Length: 30

  Title of the contact. For example, Onboarding Sponsor.
• TitleMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Meaning of the contact type.
• Type: string
  Maximum Length: 30

  Type of contact. Valid values are from the ORA_PER_ONB_CONTACT_TYPE lookup. Example, Line Manager, AOR.
• TypeMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Meaning of the contact type.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who last updated the contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "JourneyContactId":{
            "type":"integer",
            "description":"Unique identifier of the journey contact.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date the contact was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ContactPersonId":{
            "type":"integer",
            "description":"Internal identifier of the journey contact.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "Title":{
            "maxLength":"30",
            "type":"string",
            "description":"Title of the contact. For example, Onboarding Sponsor.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "TypeMeaning":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of the contact type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ContactUser":{
            "maxLength":"64",
            "type":"string",
            "description":"User name of the journey contact.",
            "nullable":true,
            "x-queryable":false
        },
        "Type":{
            "maxLength":"30",
            "type":"string",
            "description":"Type of contact. Valid values are from the ORA_PER_ONB_CONTACT_TYPE lookup. Example, Line Manager, AOR.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ResponsibilityTypeMeaning":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Responsibility type meaning of the journey contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CustomContact":{
            "maxLength":"400",
            "type":"string",
            "description":"Custom contact details",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TitleMeaning":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of the contact type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ResponsibilityType":{
            "maxLength":"30",
            "type":"string",
            "description":"Responsibility type of the journey contact.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date the contact was last 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 : journeys-events-item-response

Type: object

Show Source

• Category: string
  Category code for the event. Values are from ORA_PER_ONB_CONTENT_SBTYP_EVNT lookup. For example, Insight.
• CategoryMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Meaning of the event category meaning. For example, Insight.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date the event was created.
• Description: string
  Description of the task.
• EventDate: string
  Date of the event.
• EventOffset: integer
  Offset duration of the event.
• EventURL: string
  URL of the event.
• ImageURL: string
  URL of the event background image.
• JourneyEventId: integer (int64)
  Read Only: true

  Unique identifier of the journey event.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date the event was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the event.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Sequence: integer (int32)
  Task display ordering sequence. Default is 1.
• Title: string
  Title of the event.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who last updated the event.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"Date the event was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "EventDate":{
            "type":"string",
            "description":"Date of the event.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "sortable":false
            }
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the event.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Category":{
            "type":"string",
            "description":"Category code for the event. Values are from ORA_PER_ONB_CONTENT_SBTYP_EVNT lookup. For example, Insight.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "sortable":false
            }
        },
        "Description":{
            "type":"string",
            "description":"Description of the task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "sortable":false
            }
        },
        "EventOffset":{
            "type":"integer",
            "description":"Offset duration of the event.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "sortable":false
            }
        },
        "JourneyEventId":{
            "type":"integer",
            "description":"Unique identifier of the journey event.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "ImageURL":{
            "type":"string",
            "description":"URL of the event background image.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "sortable":false
            }
        },
        "Title":{
            "type":"string",
            "description":"Title of the event.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "sortable":false
            }
        },
        "Sequence":{
            "type":"integer",
            "description":"Task display ordering sequence. Default is 1.",
            "format":"int32",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"9"
            }
        },
        "CategoryMeaning":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of the event category meaning. For example, Insight.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "EventURL":{
            "type":"string",
            "description":"URL of the event.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "sortable":false
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date the event was last 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 : journeys-notes-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date the notes was created.
• Description: string
  Description of the task.
• EventDate: string
  Date for meeting type note.
• EventLocation: string
  Location for meeting type note.
• EventOffset: integer
  Offset value for the event.
• EventTime: string
  Time for meeting type note.
• JourneyNoteId: integer (int64)
  Read Only: true

  Unique identifier of the journey notes.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date the notes was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the notes.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Sequence: integer (int32)
  Task display ordering sequence. Default is 1.
• Title: string
  Title of the notes.
• Type: string
  Note subtype code. Values are from the ORA_PER_ONB_CONTENT_SBTYP_NOTE lookup. Example, Meeting Note, Standard Note.
• TypeMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Note subtype meaning.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who last updated the notes.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"Date the notes was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "EventDate":{
            "type":"string",
            "description":"Date for meeting type note.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "sortable":false
            }
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the notes.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Description":{
            "type":"string",
            "description":"Description of the task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "sortable":false
            }
        },
        "EventOffset":{
            "type":"integer",
            "description":"Offset value for the event.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "sortable":false
            }
        },
        "EventLocation":{
            "type":"string",
            "description":"Location for meeting type note.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "sortable":false
            }
        },
        "Title":{
            "type":"string",
            "description":"Title of the notes.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "sortable":false
            }
        },
        "Sequence":{
            "type":"integer",
            "description":"Task display ordering sequence. Default is 1.",
            "format":"int32",
            "nullable":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
        },
        "JourneyNoteId":{
            "type":"integer",
            "description":"Unique identifier of the journey notes.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "Type":{
            "type":"string",
            "description":"Note subtype code. Values are from the ORA_PER_ONB_CONTENT_SBTYP_NOTE lookup. Example, Meeting Note, Standard Note.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "sortable":false
            }
        },
        "EventTime":{
            "type":"string",
            "description":"Time for meeting type note.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "sortable":false
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date the notes was last 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 : journeys-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 group for journey template property.
• Code: string
  Code of the property in the journey template.
• 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
  Property level for the journey template.
• LineManagerDefaultValue: string
  Default value of the journey template property for line manager.
• LineManagerLookupType: string
  Line Manager type for the journey template property.
• 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.
• Sequence: integer
  Sequence of the journey template property.

{
    "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
            }
        },
        "Sequence":{
            "type":"integer",
            "description":"Sequence of the journey template property.",
            "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 property in the journey template.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CategoryMeaning":{
            "type":"string",
            "description":"Meaning of 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":"Property level for the journey template.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "LineManagerLookupType":{
            "type":"string",
            "description":"Line Manager type for the journey template property.",
            "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 : journeys-tasks-item-response

Type: object

Show Source

• ActionAddToCalendarLabel: string
  Maximum Length: 120

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

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

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

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

  Maximum Length: 1000

  The URL associated with the task that's entered on the setup screen. To retrieve a navigable URL, use the getNavigationURL custom method of the resource.
• ActivationEligibilityProfileId: integer (int64)
  Identifier of the eligibility profile used for the activation criteria in a journey task.
• ActivationEligibilityProfileName: string
  Title: Name

  Read Only: true

  Maximum Length: 240

  Name of the eligibility profile used for the activation criteria in a journey task.
• 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.
• AddToLibraryFlag: boolean
  Indicates whether the task can be added to personal task library. Valid values are Yes or No. The default is No.
• AllowAttachmentFlag: boolean
  Indicates whether attachments can be added to the task. Valid values are Yes or No. The default is No.
• AllowCommentFlag: boolean
  Indicates whether comments can be added to the task. Valid values are Yes or No. The default 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 can be added. Valid values are Yes or No. The default is No.
• AnalysisParameters: string
  Maximum Length: 4000

  Parameters associated with an analytics task type.
• AnalysisPath: string
  Maximum Length: 1000

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

  Maximum Length: 240

  Application task type.
• ApplicationTaskName: string
  Title: Application Task

  Read Only: true

  Maximum Length: 240

  Name of application task type.
• AttachmentDocumentTypeId: integer (int64)
  Description for the AttachmentDocumentTypeId attribute in the tasks resource, which is part of the journeys root resource.
• AttachmentDocumentTypeName: string
  Title: Document Type

  Read Only: true

  Maximum Length: 80

  Description for the AttachmentDocumentTypeName attribute in the tasks resource, which is part of the journeys root resource.
• CompletedFeedFlag: boolean
  Read Only: true

  Indicates whether the atom feed is enabled when a journey task is completed.
• ConfigurableFormContext: string
  Title: Configurable Form

  Maximum Length: 80

  Context for configurable form task type.
• ContactUserId: integer
  User ID of the task performer.
• ContactUserIdentifier: string
  Maximum Length: 64

  Internal identifier of the journey task performer.
• 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

  Task creation date.
• DelayDuration: integer (int32)
  Delay duration for the task.
• DelayDurationUOM: string
  Maximum Length: 30

  Unit of measure used in specifying delaying the duration.
• DelayDurationUOMMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Meaning of unit of measure used in delay duration.
• DeletedFeedFlag: boolean
  Read Only: true

  Indicates whether the atom feed is enabled when a journey task is deleted.
• DependentTaskCode: string
  Maximum Length: 240

  Code of the dependent task.
• DependentTaskId: integer (int64)
  Primary key or unique identifier of the dependent task.
• DependentTaskName: string
  Read Only: true

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

  Maximum Length: 4000

  Description of the task.
• DigitalSignatureTemplateId: string
  Identifier of the digital signature template.
• DisplayFeatures: string
  Task display features.
• DisplayOptions: string
  Maximum Length: 4000

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

  The attachments resource is used to view, create, and update attachments.
• DocumentTypeId: integer (int64)
  Title: Document Type

  Description for the document type identifier attribute. Identifier of the document type.
• DocumentTypeName: string
  Title: Document Type

  Read Only: true

  Maximum Length: 80

  Name of the document type.
• EligibilityProfileId: integer (int64)
  Title: Eligibility Profile

  Identifier of the eligibility profile.
• EligibilityProfileName: string
  Title: Name

  Read Only: true

  Maximum Length: 240

  Name of the eligibility profile.
• EmbeddedApplicationTaskCode: string
  Maximum Length: 240

  Code of the embedded application task.
• EmbeddedApplicationTaskTypeId: integer (int64)
  Unique identifier of the embedded application task.
• EnableExpiryFlag: boolean
  Maximum Length: 4

  Indicates whether the task should expire. Valid values are Yes and No. The default value is No.
• EvaluationOffset: integer (int32)
  Number of days to consider for eligibility evaluation.
• 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
  Read Only: true

  Indicates whether the atom feed is enabled for a journey task.
• InitiatedFeedFlag: boolean
  Read Only: true

  Indicates whether the atom feed is enabled when a journey task is initiated.
• JourneyTaskId: integer (int64)
  Read Only: true

  Unique identifier of the journey task.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date on which task was last 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.
• links: array Links
  Title: Links

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

  Maximum Length: 240

  Name of the journey task.
• Notes: string (byte)
  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
  Maximum Length: 150

  Title of the notes.
• 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 existing page or a new page. Valid values are Yes and No. The default value is Yes.
• OwnerPersonId: integer (int64)
  Internal identifier of the journey task owner.
• OwnerResponsibilityType: string
  Responsibility type of the journey task owner.
• OwnerResponsibilityTypeMeaning: string
  Read Only: true

  Responsibility type meaning of the journey task owner.
• OwnerType: string
  Maximum Length: 30

  Default Value: ORA_CHK_INITIATOR

  Task owner type.
• OwnerTypeMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Task owner type meaning.
• OwnerUserGroupCode: string
  Code of the owner user group.
• PerformerPersonId: integer (int64)
  Internal identifier of the journey task performer.
• PerformerResponsibilityType: string
  Responsibility type of the journey task performer.
• PerformerResponsibilityTypeMeaning: string
  Read Only: true

  Responsibility type meaning of the journey task performer.
• PerformerType: string
  Title: Responsibility Type

  Maximum Length: 30

  Default Value: ORA_WORKER

  Task performer type.
• PerformerTypeMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Task performer type meaning.
• PerformerUserGroupCode: string
  Code of the performer user group.
• ProcessCloudConfiguration: string
  Configuration of the process automation.
• properties: array Properties
  Title: Properties

  The properties resource is the child of the journeys 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.
• ReassignedFeedFlag: boolean
  Read Only: true

  Indicates whether the atom feed is enabled when a journey task is reassigned.
• ReminderDuration: integer (int32)
  Duration of the task reminder.
• ReminderRecurrence: string
  Maximum Length: 30

  Recurrence of the reminder.
• ReminderRelativeTo: string
  Maximum Length: 30

  Default Value: ORA_CHK_BFR_DUE_DT

  Reminder relative to task duration.
• ReminderRelativeToMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Meaning of reminder relative to task duration.
• ReminderTemplateId: integer (int64)
  Primary key or unique identifier of the reminder notification template.
• ReportPath: string
  Title: Report Path

  Maximum Length: 1000

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

  Maximum Length: 30

  Default Value: false

  Indicates whether the task is mandatory or optional. Valid values are Yes and No. Default is No.
• SaveAttachmentsToDORFor: string
  Document records of person for whom to save task attachments.
• SaveAttachmentsToDORForMeaning: string
  Read Only: true

  Meaning of save attachments to document records.
• SaveDocumentsToDORFor: string
  Attachments to add to document records for a document type.
• SaveDocumentsToDORForMeaning: string
  Read Only: true

  Meaning of add attachments document records.
• Sequence: integer (int32)
  Default Value: 1

  Task display ordering sequence. Default is 1.
• SignatureValidationConfiguration: string
  Validation type for electronic signature.
• SourceTaskId: integer
  Primary key or unique identifier of the source task.
• Status: string
  Title: Status

  Read Only: true

  Maximum Length: 30

  Code for the task status.
• StatusMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Status of the task.
• SubType: string
  Title: Signature Type

  Maximum Length: 30

  Task action subtype code. Available only for action types I-9 and Electronic Signature.
• SubTypeMeaning: string
  Read Only: true

  Task action subtype. Available only for action types I9 and Electronic Signature.
• TargetDuration: integer (int32)
  Title: Target Duration

  Target duration for the task.
• TargetDurationUOM: string
  Title: UOM

  Maximum Length: 30

  Unit of measure for the target duration.
• TargetDurationUOMMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Meaning of the unit of measure used in the target duration.
• TaskCode: string
  Maximum Length: 240

  Code of a task in a journey template.
• TaskGroupId: integer (int64)
  Unique identifier of the journey task group.
• Type: string
  Title: Task Type

  Maximum Length: 30

  Default Value: ORA_CHK_MANUAL

  Task action type code.
• TypeMeaning: string
  Title: Meaning

  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.
• WorkAuthorizationConfiguration: string
  Work authorization for I 9 task.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Task creation date.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SourceTaskId":{
            "type":"integer",
            "description":"Primary key or unique identifier of the source task.",
            "nullable":true,
            "x-queryable":false
        },
        "SaveDocumentsToDORForMeaning":{
            "type":"string",
            "description":"Meaning of add attachments document records.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "SaveDocumentsToDORFor"
                ]
            }
        },
        "DisplayOptions":{
            "maxLength":"4000",
            "type":"string",
            "description":"Type of OTBI analysis.",
            "nullable":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
        },
        "SaveAttachmentsToDORForMeaning":{
            "type":"string",
            "description":"Meaning of save attachments to document records.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "SaveAttachmentsToDORFor"
                ]
            }
        },
        "VideoTypeMeaning":{
            "type":"string",
            "description":"Meaning of video type.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "VideoType"
                ]
            },
            "x-queryable":true
        },
        "ActivityAction1Label":{
            "maxLength":"120",
            "type":"string",
            "description":"Setting that enables to change the label of action 1.",
            "nullable":true,
            "x-queryable":false
        },
        "OwnerType":{
            "maxLength":"30",
            "type":"string",
            "description":"Task owner type.",
            "nullable":true,
            "default":"ORA_CHK_INITIATOR",
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            }
        },
        "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
        },
        "DelayDurationUOM":{
            "maxLength":"30",
            "type":"string",
            "description":"Unit of measure used in specifying delaying the duration.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AllowAttachmentFlag":{
            "type":"boolean",
            "description":"Indicates whether attachments can be added to the task. Valid values are Yes or No. The default is No.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "DependentTaskCode":{
            "maxLength":"240",
            "type":"string",
            "description":"Code of the dependent task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "OwnerTypeMeaning":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Task owner type meaning.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "QuestionnaireId":{
            "title":"Questionnaire",
            "type":"integer",
            "description":"Internal identifier of the questionnaire.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "SaveDocumentsToDORFor":{
            "type":"string",
            "description":"Attachments to add to document records for a document type.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LearnCommunityId":{
            "type":"integer",
            "description":"Identifier of the learning community.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "LearnEnrollmentId":{
            "type":"integer",
            "description":"Identifier of the learning enrollment.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ProcessCloudConfiguration":{
            "type":"string",
            "description":"Configuration of the process automation.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "Status":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"Code for the task status.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who last updated the task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "DigitalSignatureTemplateId":{
            "type":"string",
            "description":"Identifier of the digital signature template.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "DependentTaskId":{
            "type":"integer",
            "description":"Primary key or unique identifier of the dependent task.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18",
                "sortable":false
            }
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "EligibilityProfileName":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the eligibility profile.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "FeedFlag":{
            "type":"boolean",
            "description":"Indicates whether the atom feed is enabled for a journey task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "SignatureValidationConfiguration":{
            "type":"string",
            "description":"Validation type for electronic signature.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "EvaluationOffset":{
            "type":"integer",
            "description":"Number of days to consider for eligibility evaluation.",
            "format":"int32",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "AttachmentDocumentTypeName":{
            "title":"Document Type",
            "maxLength":"80",
            "type":"string",
            "description":"Description for the AttachmentDocumentTypeName attribute in the tasks resource, which is part of the journeys root resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "AddToLibraryFlag":{
            "type":"boolean",
            "description":"Indicates whether the task can be added to personal task library. Valid values are Yes or No. The default is No.",
            "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/journeys-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
        },
        "Description":{
            "title":"Description",
            "maxLength":"4000",
            "type":"string",
            "description":"Description of the task.",
            "nullable":true,
            "x-queryable":false
        },
        "SaveAttachmentsToDORFor":{
            "type":"string",
            "description":"Document records of person for whom to save task attachments.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "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",
            "maxLength":"240",
            "type":"string",
            "description":"Name of application task type.",
            "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,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "AllowNoteTitleFlag":{
            "type":"boolean",
            "description":"Indicates whether the Notes title can be added. Valid values are Yes or No. The default is No.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "DelayDurationUOMMeaning":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of unit of measure used in delay duration.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "TaskCode":{
            "maxLength":"240",
            "type":"string",
            "description":"Code of a task in a journey template.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ActivityAction4Label":{
            "maxLength":"120",
            "type":"string",
            "description":"Setting that enables to change the label of action 4.",
            "nullable":true,
            "x-queryable":false
        },
        "JourneyTaskId":{
            "type":"integer",
            "description":"Unique identifier of the journey task.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "SubTypeMeaning":{
            "type":"string",
            "description":"Task action subtype. Available only for action types I9 and Electronic Signature.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ESignTypeMeaning",
                    "I9TypeMeaning",
                    "ProcessAutomationTypeMeaning",
                    "VideoTypeLookupMeaning",
                    "LearnTypeMeaning"
                ]
            }
        },
        "AnalysisParameters":{
            "maxLength":"4000",
            "type":"string",
            "description":"Parameters associated with an analytics task type.",
            "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":"Context for configurable form task type.",
            "nullable":true,
            "x-queryable":false
        },
        "TargetDurationUOM":{
            "title":"UOM",
            "maxLength":"30",
            "type":"string",
            "description":"Unit of measure for the target duration.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            }
        },
        "WorkAuthorizationConfiguration":{
            "type":"string",
            "description":"Work authorization for I 9 task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "PerformerResponsibilityType":{
            "type":"string",
            "description":"Responsibility type of the journey task performer.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "sortable":false
            }
        },
        "ReminderRelativeTo":{
            "maxLength":"30",
            "type":"string",
            "description":"Reminder relative to task duration.",
            "nullable":true,
            "default":"ORA_CHK_BFR_DUE_DT",
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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",
            "type":"integer",
            "description":"Description for the document type identifier attribute. Identifier of the document type.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "ActivationEligibilityProfileName":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the eligibility profile used for the activation criteria in a journey task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Type":{
            "title":"Task Type",
            "maxLength":"30",
            "type":"string",
            "description":"Task action type code.",
            "nullable":false,
            "default":"ORA_CHK_MANUAL",
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            }
        },
        "ReminderRecurrence":{
            "maxLength":"30",
            "type":"string",
            "description":"Recurrence of the reminder.",
            "nullable":true,
            "x-queryable":false
        },
        "InitiatedFeedFlag":{
            "type":"boolean",
            "description":"Indicates whether the atom feed is enabled when a journey task is initiated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ReportPath":{
            "title":"Report Path",
            "maxLength":"1000",
            "type":"string",
            "description":"Path to the report in BI Catalog.",
            "nullable":true,
            "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,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "TargetDurationUOMMeaning":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of the unit of measure used in the target duration.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LearningContentTypeMeaning":{
            "type":"string",
            "description":"Meaning of the learning content type.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "LearningContentType"
                ]
            },
            "x-queryable":true
        },
        "RequiredFlag":{
            "title":"Required",
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates whether the task is mandatory or optional. Valid values are Yes and No. Default is No.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ActionURL":{
            "title":"URL",
            "maxLength":"1000",
            "type":"string",
            "description":"The URL associated with the task that's entered on the setup screen. To retrieve a navigable URL, use the getNavigationURL custom method of the resource.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date on which task was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ContentProviderCode":{
            "maxLength":"240",
            "type":"string",
            "description":"Code of the user-defined content task.",
            "nullable":true,
            "x-queryable":false
        },
        "ActivationEligibilityProfileId":{
            "type":"integer",
            "description":"Identifier of the eligibility profile used for the activation criteria in a journey task.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "documents":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/journeys-tasks-documents-item-response"
            }
        },
        "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
        },
        "ContactUserIdentifier":{
            "maxLength":"64",
            "type":"string",
            "description":"Internal identifier of the journey task performer.",
            "nullable":true,
            "x-queryable":false
        },
        "ActionRejectLabel":{
            "maxLength":"120",
            "type":"string",
            "description":"Setting that enables to change the label of the not applicable action.",
            "nullable":true,
            "x-queryable":false
        },
        "Name":{
            "title":"Task Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the journey task.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PerformerTypeMeaning":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Task performer type meaning.",
            "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"
            }
        },
        "PerformerResponsibilityTypeMeaning":{
            "type":"string",
            "description":"Responsibility type meaning of the journey task performer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DeletedFeedFlag":{
            "type":"boolean",
            "description":"Indicates whether the atom feed is enabled when a journey task is deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "NoteTitle":{
            "maxLength":"150",
            "type":"string",
            "description":"Title of the notes.",
            "nullable":true,
            "x-queryable":false
        },
        "ReassignedFeedFlag":{
            "type":"boolean",
            "description":"Indicates whether the atom feed is enabled when a journey task is reassigned.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "DependentTaskName":{
            "type":"string",
            "description":"Name of the dependent task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OwnerResponsibilityTypeMeaning":{
            "type":"string",
            "description":"Responsibility type meaning of the journey task owner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SubType":{
            "title":"Signature Type",
            "maxLength":"30",
            "type":"string",
            "description":"Task action subtype code. Available only for action types I-9 and Electronic Signature.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ContactUserId":{
            "type":"integer",
            "description":"User ID of the task performer.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "PerformerPersonId":{
            "type":"integer",
            "description":"Internal identifier of the journey task performer.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ReminderTemplateId":{
            "type":"integer",
            "description":"Primary key or unique identifier of the reminder notification template.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "Sequence":{
            "type":"integer",
            "description":"Task display ordering sequence. Default is 1.",
            "format":"int32",
            "nullable":true,
            "default":"1",
            "x-queryable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "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
            }
        },
        "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":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of reminder relative to task duration.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "DelayDuration":{
            "type":"integer",
            "description":"Delay duration for the task.",
            "format":"int32",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "TargetDuration":{
            "title":"Target Duration",
            "type":"integer",
            "description":"Target duration for the task.",
            "format":"int32",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"9"
            }
        },
        "PerformerUserGroupCode":{
            "type":"string",
            "description":"Code of the performer user group.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "OwnerResponsibilityType":{
            "type":"string",
            "description":"Responsibility type of the journey task owner.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "sortable":false
            }
        },
        "ExpiryRelativeTo":{
            "maxLength":"30",
            "type":"string",
            "description":"Criteria based on which the task expires.",
            "nullable":true,
            "x-queryable":false
        },
        "EligibilityProfileId":{
            "title":"Eligibility Profile",
            "type":"integer",
            "description":"Identifier of the eligibility profile.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "VideoType":{
            "maxLength":"80",
            "type":"string",
            "description":"Type of video.",
            "nullable":true,
            "x-queryable":false
        },
        "AllowCommentFlag":{
            "type":"boolean",
            "description":"Indicates whether comments can be added to the task. Valid values are Yes or No. The default is No.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ActionAddToCalendarLabel":{
            "maxLength":"120",
            "type":"string",
            "description":"Setting that enables to change the label of the add to calendar action.",
            "nullable":true,
            "x-queryable":false
        },
        "AnalysisPath":{
            "maxLength":"1000",
            "type":"string",
            "description":"OTBI analysis path for an analytics task type.",
            "nullable":true,
            "x-queryable":false
        },
        "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
        },
        "ExpiryDuration":{
            "title":"Expiry Days",
            "type":"integer",
            "description":"Duration after which the task expires.",
            "format":"int32",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"5"
            }
        },
        "TaskGroupId":{
            "type":"integer",
            "description":"Unique identifier of the journey task group.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "AttachmentDocumentTypeId":{
            "type":"integer",
            "description":"Description for the AttachmentDocumentTypeId attribute in the tasks resource, which is part of the journeys root resource.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "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":"Responsibility Type",
            "maxLength":"30",
            "type":"string",
            "description":"Task performer type.",
            "nullable":true,
            "default":"ORA_WORKER",
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            }
        },
        "ApplicationTask":{
            "title":"Application Task",
            "maxLength":"240",
            "type":"string",
            "description":"Application task type.",
            "nullable":true,
            "x-queryable":false
        },
        "OwnerUserGroupCode":{
            "type":"string",
            "description":"Code of the owner user group.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "TypeMeaning":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Task action type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "StatusMeaning":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Status of the task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ReminderDuration":{
            "type":"integer",
            "description":"Duration of the task reminder.",
            "format":"int32",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"3"
            }
        },
        "DisplayFeatures":{
            "type":"string",
            "description":"Task display features.",
            "nullable":true,
            "x-queryable":false
        },
        "OwnerPersonId":{
            "type":"integer",
            "description":"Internal identifier of the journey task owner.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "properties":{
            "title":"Properties",
            "type":"array",
            "description":"The properties resource is the child of the journeys resource. It includes all the journey properties associated with the parent journey template.",
            "items":{
                "$ref":"#/components/schemas/journeys-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 : Attachments

Type: array

Title: Attachments

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

Show Source

• Array of: object journeys-tasks-documents-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/journeys-tasks-documents-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 journeys-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/journeys-tasks-notifications-item-response"
    }
}

Nested Schema : Properties

Type: array

Title: Properties

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

Show Source

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

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

Nested Schema : journeys-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

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

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  The user who created the record.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  The user name who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• DownloadInfo: string
  Title: DownloadInfo

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

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

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

  Maximum Length: 2048

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

  The URI of the file.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

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

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

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

  Read Only: true

  The user name who last updated the record.
• links: array Links
  Title: Links

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

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

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

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

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

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

  Read Only: true

  Maximum Length: 255

  The login credentials of the user who created the attachment.

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : journeys-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.
• JourneyTaskNotificationId: integer (int64)
  Read Only: true

  Unique identifier of the journey task notification.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date on which the notification was last 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
  Maximum Length: 30

  Indicates if the task owner needs to be notified when the event occurs. Valid values are Yes and No. Default is No.
• NotifyPerformerFlag: boolean
  Maximum Length: 30

  Indicates if the task performer needs to be notified when the event occurs. Valid values are Yes and No. Default is Yes.
• OwnerExpiryTemplateId: integer (int64)
  Primary key or unique identifier of the expiry notification template for task owner.
• OwnerForceCompleteTemplateId: integer (int64)
  Primary key or unique identifier of the force completion notification template for task owner.
• OwnerNotApplicableTemplateId: integer (int64)
  Primary key or unique identifier of the notification template when a task is marked as not applicable for task owner.
• OwnerTemplateId: integer (int64)
  Primary key or unique identifier of the notification template for task owner.
• PerformerExpiryTemplateId: integer (int64)
  Primary key or unique identifier of the expiry notification template for task performer.
• PerformerForceCompleteTemplateId: integer (int64)
  Primary key or unique identifier of the force completion notification template for task performer.
• PerformerNotApplicableTemplateId: integer (int64)
  Primary key or unique identifier of the notification template when a task is marked as not applicable for task performer.
• PerformerTemplateId: integer (int64)
  Primary key or unique identifier of the notification template for task performer.
• TaskEvent: string
  Maximum Length: 30

  Code of the task event. Example, task initiated, task updated, task deleted, task completed.
• TaskEventMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Meaning of the task event.

{
    "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
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the notification.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "NotifyPerformerFlag":{
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates if the task performer needs to be notified when the event occurs. Valid values are Yes and No. Default is Yes.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "OwnerNotApplicableTemplateId":{
            "type":"integer",
            "description":"Primary key or unique identifier of the notification template when a task is marked as not applicable for task owner.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "OwnerForceCompleteTemplateId":{
            "type":"integer",
            "description":"Primary key or unique identifier of the force completion notification template for task owner.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PerformerExpiryTemplateId":{
            "type":"integer",
            "description":"Primary key or unique identifier of the expiry notification template for task performer.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "TaskEventMeaning":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of the task event.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "TaskEvent":{
            "maxLength":"30",
            "type":"string",
            "description":"Code of the task event. Example, task initiated, task updated, task deleted, task completed.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "NotifyOwnerFlag":{
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates if the task owner needs to be notified when the event occurs. Valid values are Yes and No. Default 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"
            }
        },
        "PerformerTemplateId":{
            "type":"integer",
            "description":"Primary key or unique identifier of the notification template for task performer.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "JourneyTaskNotificationId":{
            "type":"integer",
            "description":"Unique identifier of the journey task notification.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "OwnerTemplateId":{
            "type":"integer",
            "description":"Primary key or unique identifier of the notification template for task owner.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "OwnerExpiryTemplateId":{
            "type":"integer",
            "description":"Primary key or unique identifier of the expiry notification template for task owner.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PerformerForceCompleteTemplateId":{
            "type":"integer",
            "description":"Primary key or unique identifier of the force completion notification template for task performer.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date on which the notification was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PerformerNotApplicableTemplateId":{
            "type":"integer",
            "description":"Primary key or unique identifier of the notification template when a task is marked as not applicable for task performer.",
            "format":"int64",
            "nullable":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 : journeys-tasks-properties-item-response

Type: object

Show Source

• Category: string
  Name of the group for journey template task property.
• CategoryMeaning: string
  Meaning of the group for journey template task property.
• Code: string
  Code of the journey template task property.
• DisabledForLineManagerFlag: boolean
  Indicates if the 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 type 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
  Value of the journey template task property 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
  Value of the journey template task property for owner.
• PerformerDefaultValue: string
  Default value of the journey template task property for performer.
• PerformerLookupType: string
  Journey template task property type for performer.
• PerformerValue: string
  Value of the journey template task property 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":"Value of the journey template task property 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":"Code of the journey template task property.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CategoryMeaning":{
            "type":"string",
            "description":"Meaning of the 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":"Value of the journey template task property 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 the 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 type for performer.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "LineManagerLookupType":{
            "type":"string",
            "description":"Journey template task property type for line manager.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "OwnerValue":{
            "type":"string",
            "description":"Value of the journey template task property 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 : journeys-taskTypes-item-response

Type: object

Show Source

• Code: string
  Maximum Length: 61

  Code of the journey template task type property.
• JourneyId: integer
  Identifier 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 Properties
  Title: Properties

  The properties resource is the child of the journeys 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

  Type meaning of the journey template task type property.

{
    "type":"object",
    "properties":{
        "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
            }
        },
        "JourneyId":{
            "type":"integer",
            "description":"Identifier of the journey template task type property.",
            "nullable":true,
            "x-queryable":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":"Properties",
            "type":"array",
            "description":"The properties resource is the child of the journeys resource. It includes all the journey properties associated with the parent journey template.",
            "items":{
                "$ref":"#/components/schemas/journeys-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":"Type 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 : Properties

Type: array

Title: Properties

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

Show Source

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

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

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

Type: object

Show Source

• Category: string
  Category of the journey template task type property.
• CategoryMeaning: string
  Meaning of category 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":"Category of the 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 category 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

allStepTasks

Operation: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/allStepTasks

Parameters:

• JourneyId: $request.path.JourneyId

The allStepTasks resource is a child of the journeys resource. It includes all the tasks in the parent journey template.

contacts

Operation: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/contacts

Parameters:

• JourneyId: $request.path.JourneyId

The contacts resource is a child of the journeys resource. It includes a list of contacts associated with the parent journey template.

duplicateJourney

Operation: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/action/duplicateJourney

Parameters:

• JourneyId: $request.path.JourneyId

Duplicates a selected journey template.

events

Operation: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/events

Parameters:

• JourneyId: $request.path.JourneyId

The events resource is a child of the journeys resource. It includes all events associated with the parent journey template.

notes

Operation: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/notes

Parameters:

• JourneyId: $request.path.JourneyId

The notes resource is a child of the journeys resource. It includes all the notes associated with the parent journey template.

properties

Operation: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/properties

Parameters:

• JourneyId: $request.path.JourneyId

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

taskTypes

Operation: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/taskTypes

Parameters:

• JourneyId: $request.path.JourneyId

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

tasks

Operation: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks

Parameters:

• JourneyId: $request.path.JourneyId

The tasks resource is a child of the journeys resource. It includes all the tasks in the parent journey template.

toggleFavourite

Operation: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/action/toggleFavourite

Parameters:

• JourneyId: $request.path.JourneyId

Finds favorite journeys for the logged in user.

Back to Top