Jump to

• Request
• Response

Update a personal library task

patch

/hcmRestApi/resources/11.13.18.05/journeyTaskLibrary/{LibraryJourneyTaskId}

Request

Path Parameters

• LibraryJourneyTaskId(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

• 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.
• AllowAttachmentFlag: boolean
  Indicates whether attachments are enabled for a task. Valid values are Yes or No. Default is No.
• AllowCommentFlag: boolean
  Indicates whether comments are enabled for a task. Valid values are Yes or No. 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)
  Attachments to add to document records for the given document type.
• CompletedFeedFlag: boolean
  Indicates whether the atom feed is enabled when a journey task is completed.
• DeletedFeedFlag: boolean
  Indicates whether the atom feed is enabled when a journey task is deleted.
• Description: string
  Maximum Length: 4000

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

  The attachments resource is used to view, create, and update attachments.
• FeedFlag: boolean
  Indicates whether the atom feed is enabled for a journey task.
• InitiatedFeedFlag: boolean
  Indicates whether the atom feed is enabled when a journey task is initiated.
• Name: string
  Title: Name

  Maximum Length: 240

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

  The notifications resource is a child of the tasks resource. It includes a list of 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
  Maximum Length: 30

  Default Value: ORA_WORKER

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

  The properties resource is a child of the tasks resource. It provides a list of properties settings for the task performer and owner.
• ReassignedFeedFlag: boolean
  Indicates whether the atom feed is enabled when a journey task is reassigned.
• RequiredFlag: boolean
  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
  Identifies whether the attachments should be saved for the journey assignee or the task performer.
• 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)
  Duration of the task.
• TargetDurationUOM: string
  Maximum Length: 30

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

  Maximum Length: 30

  Default Value: ORA_CHK_MANUAL

  Code of task action type.

{
    "type":"object",
    "properties":{
        "TargetDuration":{
            "type":"integer",
            "description":"Duration of the task.",
            "format":"int32",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "Description":{
            "maxLength":"4000",
            "type":"string",
            "description":"Description of the task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "PerformerUserGroupCode":{
            "type":"string",
            "description":"Code of the performer user group.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "SaveAttachmentsToDORFor":{
            "type":"string",
            "description":"Identifies whether the attachments should be saved for the journey assignee or the task performer.",
            "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":{
                "sortable":false
            }
        },
        "documents":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/journeyTaskLibrary-documents-item-patch-request"
            }
        },
        "CompletedFeedFlag":{
            "type":"boolean",
            "description":"Indicates whether the atom feed is enabled when a journey task is completed.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of journey task.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "AllowCommentFlag":{
            "type":"boolean",
            "description":"Indicates whether comments are enabled for a task. Valid values are Yes or No. Default is No.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "OwnerType":{
            "maxLength":"30",
            "type":"string",
            "description":"Task owner type.",
            "nullable":true,
            "default":"ORA_CHK_INITIATOR",
            "x-queryable":false
        },
        "AllowAttachmentFlag":{
            "type":"boolean",
            "description":"Indicates whether attachments are enabled for a task. Valid values are Yes or No. Default is No.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ProcessCloudConfiguration":{
            "type":"string",
            "description":"Configuration of the process automation.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "DeletedFeedFlag":{
            "type":"boolean",
            "description":"Indicates whether the atom feed is enabled when a journey task is deleted.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "Notes":{
            "type":"string",
            "description":"Notes for a task. The notes text is stored as a CLOB object. To use in the payload, the text should be converted to a base64 encoded string using either a conversion tool or a prerequisite script.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "TargetDurationUOM":{
            "maxLength":"30",
            "type":"string",
            "description":"Unit of measure for target duration.",
            "nullable":true,
            "x-queryable":false
        },
        "ReassignedFeedFlag":{
            "type":"boolean",
            "description":"Indicates whether the atom feed is enabled when a journey task is reassigned.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "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
            }
        },
        "PerformerPersonId":{
            "type":"integer",
            "description":"Internal identifier of the journey task performer.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PerformerResponsibilityType":{
            "type":"string",
            "description":"Responsibility type of the journey task performer.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "AttachmentDocumentTypeId":{
            "type":"integer",
            "description":"Attachments to add to document records for the given document type.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "FeedFlag":{
            "type":"boolean",
            "description":"Indicates whether the atom feed is enabled for a journey task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "PerformerType":{
            "maxLength":"30",
            "type":"string",
            "description":"Task performer type.",
            "nullable":true,
            "default":"ORA_WORKER",
            "x-queryable":false
        },
        "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":"Code of task action type.",
            "nullable":false,
            "default":"ORA_CHK_MANUAL",
            "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,
            "x-queryable":false,
            "x-hints":{
                "sortable":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
            }
        },
        "InitiatedFeedFlag":{
            "type":"boolean",
            "description":"Indicates whether the atom feed is enabled when a journey task is initiated.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "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
            }
        },
        "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,
            "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"
            }
        },
        "notifications":{
            "title":"Journey Task Library Notifications",
            "type":"array",
            "description":"The notifications resource is a child of the tasks resource. It includes a list of notification settings for the task performer and owner.",
            "items":{
                "$ref":"#/components/schemas/journeyTaskLibrary-notifications-item-patch-request"
            }
        },
        "properties":{
            "title":"Journey Task Library Properties",
            "type":"array",
            "description":"The properties resource is a child of the tasks resource. It provides a list of properties settings for the task performer and owner.",
            "items":{
                "$ref":"#/components/schemas/journeyTaskLibrary-properties-item-patch-request"
            }
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

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

Show Source

• Array of: object schema

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

Nested Schema : Journey Task Library Notifications

Type: array

Title: Journey Task Library Notifications

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

Show Source

• Array of: object schema

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

Nested Schema : Journey Task Library Properties

Type: array

Title: Journey Task Library Properties

The properties resource is a child of the tasks resource. It provides a list of properties settings for the task performer and owner.

Show Source

• Array of: object journeyTaskLibrary-properties-item-patch-request

{
    "title":"Journey Task Library Properties",
    "type":"array",
    "description":"The properties resource is a child of the tasks resource. It provides a list of properties settings for the task performer and owner.",
    "items":{
        "$ref":"#/components/schemas/journeyTaskLibrary-properties-item-patch-request"
    }
}

Nested Schema : schema

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 : schema

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.

{
    "type":"object",
    "properties":{
        "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
            }
        },
        "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
            }
        }
    }
}

Nested Schema : journeyTaskLibrary-properties-item-patch-request

Type: object

Show Source

• Category: string
  Category of the for journey template task property.
• CategoryMeaning: string
  Meaning of category of 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 type property 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 type property for other user.
• OthersValue: string
  Value of the journey template task property for other user.
• OverriddenFlag: boolean
  Maximum Length: 80

  Indicates if the journey template task property is overridden. Default value depends on the task type.
• OwnerDefaultValue: string
  Default value of the journey template task property for owner.
• OwnerLookupType: string
  Maximum Length: 80

  Journey template task type property 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 type property 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":"Category of the 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 category of 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 type property 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":{
            "maxLength":"80",
            "type":"boolean",
            "description":"Indicates if the journey template task 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 type property for performer.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "LineManagerLookupType":{
            "type":"string",
            "description":"Journey template task type property 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":{
            "maxLength":"80",
            "type":"string",
            "description":"Journey template task type property 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
            }
        }
    }
}

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 : journeyTaskLibrary-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.
• AllowAttachmentFlag: boolean
  Indicates whether attachments are enabled for a task. Valid values are Yes or No. Default is No.
• AllowCommentFlag: boolean
  Indicates whether comments are enabled for a task. Valid values are Yes or No. 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 is hidden or not. Valid values are Yes and No. 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 the application task.
• AttachmentDocumentTypeId: integer (int64)
  Attachments to add to document records for the given document type.
• AttachmentDocumentTypeName: string
  Title: Document Type

  Read Only: true

  Maximum Length: 80

  Attachments to add to document records for the given document type name.
• CompletedFeedFlag: boolean
  Indicates whether the atom feed is enabled when a journey task is completed.
• ConfigurableFormContext: string
  Title: Configurable Form

  Maximum Length: 80

  Context for the configurable form task type.
• ContentProviderCode: string
  Maximum Length: 240

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

  Maximum Length: 64

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

  Date on which the task was created.
• 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
  Indicates whether the atom feed is enabled when a journey task is deleted.
• Description: string
  Maximum Length: 4000

  Description of the task.
• DigitalSignatureTemplateId: string
  Identifier for the electronic signature template.
• DisplayFeatures: string
  Display features for the electronic signature task type.
• 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

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

  Read Only: true

  Maximum Length: 80

  Name of the document type.
• EligibilityProfileId: integer (int64)
  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
  Indicates whether the atom feed is enabled for a journey task.
• InitiatedFeedFlag: boolean
  Indicates whether the atom feed is enabled when a journey task is initiated.
• LastUpdateDate: string (date-time)
  Read Only: true

  User who last updated the task.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Date on which the task was updated.
• LearnCommunityId: integer (int64)
  Identifier of the learning community.
• LearnEnrollmentId: integer (int64)
  Identifier of the learning enrollment.
• LearnEnrollmentType: string
  Maximum Length: 80

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

  Maximum Length: 80

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

  Meaning of the learning content type.
• LearningItemId: integer (int64)
  Unique identifier of the learning item.
• LibraryJourneyTaskId: integer (int64)
  Unique identifier of the journey task.
• links: array Links
  Title: Links

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

  Maximum Length: 240

  Name of journey task.
• Notes: string (byte)
  Notes for a task. The notes text is stored as a CLOB object. To use in the payload, the text should be converted to a base64 encoded string using either a conversion tool or a prerequisite script.
• NoteTitle: string
  Maximum Length: 150

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

  The notifications resource is a child of the tasks resource. It includes a list of 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

  Meaning of 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.
• PerformerResponsibilityTypeMeaning: string
  Read Only: true

  Responsibility type meaning of the journey task performer.
• PerformerType: string
  Maximum Length: 30

  Default Value: ORA_WORKER

  Task performer type.
• PerformerTypeMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

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

  The properties resource is a child of the tasks resource. It provides a list of properties settings for the task performer and owner.
• 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
  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 task 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
  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
  Identifies whether the attachments should be saved for the journey assignee or the task performer.
• SaveAttachmentsToDORForMeaning: string
  Read Only: true

  Identifies whether the attachments should be saved for the journey assignee or the task performer in 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.
• SignatureValidationConfiguration: string
  Validation type for electronic signature.
• Status: string
  Title: Status

  Read Only: true

  Maximum Length: 30

  Default Value: ORA_CHK_TASK_ACTIVE

  Status code of the task.
• 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 task action types I9 and Electronic Signature.
• TargetDuration: integer (int32)
  Duration of the task.
• TargetDurationUOM: string
  Maximum Length: 30

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

  Read Only: true

  Maximum Length: 80

  Meaning of the unit of measure for task duration.
• TaskLevel: string
  Read Only: true

  Maximum Length: 30

  Default Value: ORA_GLOBAL

  Indicates whether the task is at the global or person level.
• TaskLevelMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Meaning of the task level.
• TaskLevelValue: integer (int64)
  Read Only: true

  Default Value: 0

  Identifies whether the task is at the global or person level based on the value.
• Type: string
  Title: Task Type

  Maximum Length: 30

  Default Value: ORA_CHK_MANUAL

  Code of task action type.
• TypeMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

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

  Maximum Length: 80

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

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

  Maximum Length: 1000

  URL of the video.
• WorkAuthorizationConfiguration: string
  Work authorization for I 9 task.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date on which the task was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SaveDocumentsToDORForMeaning":{
            "type":"string",
            "description":"Meaning of add attachments 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":"Identifies whether the attachments should be saved for the journey assignee or the task performer in 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
        },
        "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
        },
        "AllowAttachmentFlag":{
            "type":"boolean",
            "description":"Indicates whether attachments are enabled for a task. Valid values are Yes or No. Default is No.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "OwnerTypeMeaning":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of task owner type.",
            "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"
            }
        },
        "LearnCommunityId":{
            "type":"integer",
            "description":"Identifier of the learning community.",
            "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
            }
        },
        "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":"Status code of the task.",
            "nullable":true,
            "readOnly":true,
            "default":"ORA_CHK_TASK_ACTIVE",
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Date on which the task was updated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "DigitalSignatureTemplateId":{
            "type":"string",
            "description":"Identifier for the electronic signature template.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "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,
            "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":"Attachments to add to document records for the given document type name.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "notifications":{
            "title":"Journey Task Library Notifications",
            "type":"array",
            "description":"The notifications resource is a child of the tasks resource. It includes a list of notification settings for the task performer and owner.",
            "items":{
                "$ref":"#/components/schemas/journeyTaskLibrary-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":{
            "maxLength":"4000",
            "type":"string",
            "description":"Description of the task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "SaveAttachmentsToDORFor":{
            "type":"string",
            "description":"Identifies whether the attachments should be saved for the journey assignee or the task performer.",
            "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
        },
        "TaskLevelMeaning":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of the task level.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "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 the application task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CompletedFeedFlag":{
            "type":"boolean",
            "description":"Indicates whether the atom feed is enabled when a journey task is completed.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "AllowNoteTitleFlag":{
            "type":"boolean",
            "description":"Indicates whether the Notes title is hidden or not. Valid values are Yes and No. 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
        },
        "ActivityAction4Label":{
            "maxLength":"120",
            "type":"string",
            "description":"Setting that enables to change the label of action 4.",
            "nullable":true,
            "x-queryable":false
        },
        "SubTypeMeaning":{
            "type":"string",
            "description":"Task action subtype. Available only for task 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 the configurable form task type.",
            "nullable":true,
            "x-queryable":false
        },
        "TargetDurationUOM":{
            "maxLength":"30",
            "type":"string",
            "description":"Unit of measure for target duration.",
            "nullable":true,
            "x-queryable":false
        },
        "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":{
                "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"
            }
        },
        "VideoURL":{
            "maxLength":"1000",
            "type":"string",
            "description":"URL of the video.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EmbeddedApplicationTaskTypeId":{
            "type":"integer",
            "description":"Unique identifier of the embedded application task.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "DocumentTypeId":{
            "title":"Document Type",
            "type":"integer",
            "description":"Identifier for 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":"Code of task action type.",
            "nullable":false,
            "default":"ORA_CHK_MANUAL",
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ReminderRecurrence":{
            "maxLength":"30",
            "type":"string",
            "description":"Recurrence of the task reminder.",
            "nullable":true,
            "x-queryable":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
            }
        },
        "InitiatedFeedFlag":{
            "type":"boolean",
            "description":"Indicates whether the atom feed is enabled when a journey task is initiated.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "TargetDurationUOMMeaning":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of the unit of measure for task 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":{
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates whether the task is mandatory or optional. Valid values are Yes and No. Default is No.",
            "nullable":true,
            "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":"User who last updated the task.",
            "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/journeyTaskLibrary-documents-item-response"
            }
        },
        "LearningContentType":{
            "maxLength":"80",
            "type":"string",
            "description":"Type of learning content.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EmbeddedApplicationTaskCode":{
            "maxLength":"240",
            "type":"string",
            "description":"Code of the embedded application task.",
            "nullable":true,
            "x-queryable":false
        },
        "ActionRejectLabel":{
            "maxLength":"120",
            "type":"string",
            "description":"Setting that enables to change the label of the not applicable action.",
            "nullable":true,
            "x-queryable":false
        },
        "Name":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of journey task.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PerformerTypeMeaning":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of task performer type.",
            "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,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "NoteTitle":{
            "maxLength":"150",
            "type":"string",
            "description":"Title of the Notes section in the task.",
            "nullable":true,
            "x-queryable":false
        },
        "TaskLevelValue":{
            "type":"integer",
            "description":"Identifies whether the task is at the global or person level based on the value.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "default":"0",
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReassignedFeedFlag":{
            "type":"boolean",
            "description":"Indicates whether the atom feed is enabled when a journey task is reassigned.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "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
            }
        },
        "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"
            }
        },
        "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":{
            "type":"integer",
            "description":"Duration of the task.",
            "format":"int32",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "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":{
                "sortable":false
            }
        },
        "LibraryJourneyTaskId":{
            "type":"integer",
            "description":"Unique identifier of the journey task.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "ExpiryRelativeTo":{
            "maxLength":"30",
            "type":"string",
            "description":"Criteria based on which the task expires.",
            "nullable":true,
            "x-queryable":false
        },
        "EligibilityProfileId":{
            "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,
            "readOnly":true,
            "x-queryable":false
        },
        "ActionAddToCalendarLabel":{
            "maxLength":"120",
            "type":"string",
            "description":"Setting that enables to change the label of the add to calendar action.",
            "nullable":true,
            "x-queryable":false
        },
        "AllowCommentFlag":{
            "type":"boolean",
            "description":"Indicates whether comments are enabled for a task. Valid values are Yes or No. Default is No.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "AnalysisPath":{
            "maxLength":"1000",
            "type":"string",
            "description":"OTBI analysis path for an analytics task type.",
            "nullable":true,
            "x-queryable":false
        },
        "Notes":{
            "type":"string",
            "description":"Notes for a task. The notes text is stored as a CLOB object. To use in the payload, the text should be converted to a base64 encoded string using either a conversion tool or a prerequisite script.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ExpiryDuration":{
            "title":"Expiry Days",
            "type":"integer",
            "description":"Duration after which the task expires.",
            "format":"int32",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"5"
            }
        },
        "AttachmentDocumentTypeId":{
            "type":"integer",
            "description":"Attachments to add to document records for the given document type.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "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":{
            "maxLength":"30",
            "type":"string",
            "description":"Task performer type.",
            "nullable":true,
            "default":"ORA_WORKER",
            "x-queryable":false
        },
        "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"
            }
        },
        "TaskLevel":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether the task is at the global or person level.",
            "nullable":true,
            "readOnly":true,
            "default":"ORA_GLOBAL",
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DisplayFeatures":{
            "type":"string",
            "description":"Display features for the electronic signature task type.",
            "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":"Journey Task Library Properties",
            "type":"array",
            "description":"The properties resource is a child of the tasks resource. It provides a list of properties settings for the task performer and owner.",
            "items":{
                "$ref":"#/components/schemas/journeyTaskLibrary-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 journeyTaskLibrary-documents-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/journeyTaskLibrary-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 : Journey Task Library Notifications

Type: array

Title: Journey Task Library Notifications

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

Show Source

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

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

Nested Schema : Journey Task Library Properties

Type: array

Title: Journey Task Library Properties

The properties resource is a child of the tasks resource. It provides a list of properties settings for the task performer and owner.

Show Source

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

{
    "title":"Journey Task Library Properties",
    "type":"array",
    "description":"The properties resource is a child of the tasks resource. It provides a list of properties settings for the task performer and owner.",
    "items":{
        "$ref":"#/components/schemas/journeyTaskLibrary-properties-item-response"
    }
}

Nested Schema : journeyTaskLibrary-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 : 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 : journeyTaskLibrary-notifications-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

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

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

  Maximum Length: 64

  User who last updated notification.
• LibraryJourneyTaskNotificationId: integer (int64)
  Unique identifier of the journey task 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. For 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 notification.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LibraryJourneyTaskNotificationId":{
            "type":"integer",
            "description":"Unique identifier of the journey task notification.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "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
        },
        "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"
            }
        },
        "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
            }
        },
        "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. For 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"
            }
        },
        "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 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 : journeyTaskLibrary-properties-item-response

Type: object

Show Source

• Category: string
  Category of the for journey template task property.
• CategoryMeaning: string
  Meaning of category of 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 type property for line manager.
• LineManagerValue: string
  Value of the journey template task property for line manager.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Name of the journey template task property.
• OthersDefaultValue: string
  Default value of the journey template task property for other user.
• OthersLookupType: string
  Journey template task type property for other user.
• OthersValue: string
  Value of the journey template task property for other user.
• OverriddenFlag: boolean
  Maximum Length: 80

  Indicates if the journey template task property is overridden. Default value depends on the task type.
• OwnerDefaultValue: string
  Default value of the journey template task property for owner.
• OwnerLookupType: string
  Maximum Length: 80

  Journey template task type property 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 type property 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":"Category of the 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 category of 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 type property 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":{
            "maxLength":"80",
            "type":"boolean",
            "description":"Indicates if the journey template task 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 type property for performer.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "LineManagerLookupType":{
            "type":"string",
            "description":"Journey template task type property 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":{
            "maxLength":"80",
            "type":"string",
            "description":"Journey template task type property 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"
    }
}

Links

attachmentDocumentTypesLOV

Operation: /hcmRestApi/resources/11.13.18.05/hrDocumentTypesLOV

The following properties are defined on the LOV link relation:

• Source Attribute: AttachmentDocumentTypeId; Target Attribute: DocumentTypeId
• Display Attribute: DocumentType, LegislationCode, Category

documentTypesLOV

Operation: /hcmRestApi/resources/11.13.18.05/hrDocumentTypesLOV

The following properties are defined on the LOV link relation:

• Source Attribute: DocumentTypeId; Target Attribute: DocumentTypeId
• Display Attribute: DocumentType, LegislationCode, Category

documents

Operation: /hcmRestApi/resources/11.13.18.05/journeyTaskLibrary/{LibraryJourneyTaskId}/child/documents

Parameters:

• LibraryJourneyTaskId: $request.path.LibraryJourneyTaskId

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

notifications

Operation: /hcmRestApi/resources/11.13.18.05/journeyTaskLibrary/{LibraryJourneyTaskId}/child/notifications

Parameters:

• LibraryJourneyTaskId: $request.path.LibraryJourneyTaskId

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

properties

Operation: /hcmRestApi/resources/11.13.18.05/journeyTaskLibrary/{LibraryJourneyTaskId}/child/properties

Parameters:

• LibraryJourneyTaskId: $request.path.LibraryJourneyTaskId

The properties resource is a child of the tasks resource. It provides a list of properties settings for the task performer and owner.

reminderRelativeToLov

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_PER_CHK_TASK_REMINDER_TIME

The following properties are defined on the LOV link relation:

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

Back to Top