Update a task in a journey template
patch
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId}
Request
Path Parameters
-
JourneyId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
-
JourneyTaskId(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
Root Schema : schema
Type:
Show Source
object
-
ActionAddToCalendarLabel: string
Maximum Length:
120
Setting that enables to change the label of the add to calendar action. -
ActionCompleteLabel: string
Maximum Length:
120
Setting that enables to change the label of the complete action. -
ActionRejectLabel: string
Maximum Length:
120
Setting that enables to change the label of the not applicable action. -
ActionSaveLabel: string
Maximum Length:
120
Setting that enables to change the label of the save as draft action. -
ActionURL: string
Title:
URL
Maximum Length:1000
The URL associated with the task that's entered on the setup screen. To retrieve a navigable URL, use the getNavigationURL custom method of the resource. -
ActivityAction1Label: string
Maximum Length:
120
Setting that enables to change the label of action 1. -
ActivityAction2Label: string
Maximum Length:
120
Setting that enables to change the label of action 2. -
ActivityAction3Label: string
Maximum Length:
120
Setting that enables to change the label of action 3. -
ActivityAction4Label: string
Maximum Length:
120
Setting that enables to change the label of action 4. -
ActivityAction5Label: string
Maximum Length:
120
Setting that enables to change the label of action 5. -
AllowAttachmentFlag: boolean
Indicates whether attachments can be added to the task. Valid values are Yes or No. The default is No.
-
AllowCommentFlag: boolean
Indicates whether comments can be added to the task. Valid values are Yes or No. The default is No.
-
AllowNotesContentFlag: boolean
Indicates whether rich content can be added for notes. Valid values are Yes or No. The default is Yes.
-
AttachmentDocumentTypeId: integer
(int64)
Description for the AttachmentDocumentTypeId attribute in the tasks resource, which is part of the journeys root resource.
-
ContactUserId: integer
User ID of the task performer.
-
ContactUserIdentifier: string
Maximum Length:
64
Internal identifier of the journey task performer. -
ContentProviderCode: string
Maximum Length:
240
Code of the user-defined content task. -
DependentTaskId: integer
(int64)
Primary key or unique identifier of the dependent task.
-
Description: string
Title:
Description
Maximum Length:4000
Description of the task. -
documents: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
EnableExpiryFlag: boolean
Maximum Length:
4
Indicates whether the task should expire. Valid values are Yes and No. The default value is No. -
ExpiryDuration: integer
(int32)
Title:
Expiry Days
Duration after which the task expires. -
ExpiryRelativeTo: string
Maximum Length:
30
Criteria based on which the task expires. -
LearnCommunityId: integer
(int64)
Identifier of the learning community.
-
LearnEnrollmentId: integer
(int64)
Identifier of the learning enrollment.
-
LearnEnrollmentType: string
Maximum Length:
80
Type of learning enrollment. -
Name: string
Title:
Task Name
Maximum Length:240
Name of the journey task. -
Notes: string
(byte)
Notes for the task. The notes text is stored as a CLOB object. To use in the payload, the text should be converted to a base64 encoded string using either a conversion tool or a prerequisite script.
-
notifications: array
Notifications
Title:
Notifications
The notifications resource is a child of the tasks resource. It includes notification settings for the task performer and owner. -
OpenInSamePageFlag: boolean
Indicates whether the external URL should open in the existing page or a new page. Valid values are Yes and No. The default value is No.
-
OpenReportInSamePageFlag: boolean
Indicates whether the report should open in the existing page or a new page. Valid values are Yes and No. The default value is Yes.
-
OwnerPersonId: integer
(int64)
Internal identifier of the journey task owner.
-
OwnerResponsibilityType: string
Responsibility type of the journey task owner.
-
OwnerType: string
Maximum Length:
30
Default Value:ORA_CHK_INITIATOR
Task owner type. -
OwnerUserGroupCode: string
Code of the owner user group.
-
PerformerPersonId: integer
(int64)
Internal identifier of the journey task performer.
-
PerformerResponsibilityType: string
Responsibility type of the journey task performer.
-
PerformerType: string
Title:
Responsibility Type
Maximum Length:30
Default Value:ORA_WORKER
Task performer type. -
PerformerUserGroupCode: string
Code of the performer user group.
-
properties: array
Properties
Title:
Properties
The properties resource is the child of the journeys resource. It includes all the journey properties associated with the parent journey template. -
ReminderDuration: integer
(int32)
Duration of the task reminder.
-
ReminderRecurrence: string
Maximum Length:
30
Recurrence of the reminder. -
ReminderRelativeTo: string
Maximum Length:
30
Default Value:ORA_CHK_BFR_DUE_DT
Reminder relative to task duration. -
ReminderTemplateId: integer
(int64)
Primary key or unique identifier of the reminder notification template.
-
RequiredFlag: boolean
Title:
Required
Maximum Length:30
Default Value:false
Indicates whether the task is mandatory or optional. Valid values are Yes and No. Default is No. -
SaveAttachmentsToDORFor: string
Document records of person for whom to save task attachments.
-
Sequence: integer
(int32)
Default Value:
1
Task display ordering sequence. Default is 1. -
SubType: string
Title:
Signature Type
Maximum Length:30
Task action subtype code. Available only for action types I-9 and Electronic Signature. -
TargetDuration: integer
(int32)
Title:
Target Duration
Target duration for the task. -
TargetDurationUOM: string
Title:
UOM
Maximum Length:30
Unit of measure for the target duration. -
Type: string
Title:
Task Type
Maximum Length:30
Default Value:ORA_CHK_MANUAL
Task action type code.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Notifications
Type:
array
Title:
Notifications
The notifications resource is a child of the tasks resource. It includes notification settings for the task performer and owner.
Show Source
Nested Schema : Properties
Type:
array
Title:
Properties
The properties resource is the child of the journeys resource. It includes all the journey properties associated with the parent journey template.
Show Source
Nested Schema : journeys-tasks-documents-item-patch-request
Type:
Show Source
object
-
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
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.
Nested Schema : schema
Type:
Show Source
object
-
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.
Nested Schema : journeys-tasks-properties-item-patch-request
Type:
Show Source
object
-
Category: string
Name of the group for journey template task property.
-
CategoryMeaning: string
Meaning of the group for journey template task property.
-
Code: string
Code of the journey template task property.
-
DisabledForLineManagerFlag: boolean
Indicates if the journey template task property is disabled for line manager. Default value depends on the task type.
-
DisabledForOthersFlag: boolean
Indicates if the journey template task property is disabled for other users. Default value depends on the task type.
-
DisabledForOwnerFlag: boolean
Indicates if the journey template task property is disabled for owner. Default value depends on the task type.
-
DisabledForPerformerFlag: boolean
Indicates if the journey template task property is disabled for performer. Default value depends on the task type.
-
Level: string
Property level for the journey template task.
-
LineManagerDefaultValue: string
Default value of the journey template task property for line manager.
-
LineManagerLookupType: string
Journey template task property type for line manager.
-
LineManagerValue: string
Value of the journey template task property for line manager.
-
Name: string
Name of the journey template task property.
-
OthersDefaultValue: string
Default value of the journey template task property for other user.
-
OthersLookupType: string
Journey template task property type for other user.
-
OthersValue: string
Value of the journey template task property for other user.
-
OverriddenFlag: boolean
Indicates if the journey template property is overridden. Default value depends on the task type.
-
OwnerDefaultValue: string
Default value of the journey template task property for owner.
-
OwnerLookupType: string
Journey template task property type for owner.
-
OwnerValue: string
Value of the journey template task property for owner.
-
PerformerDefaultValue: string
Default value of the journey template task property for performer.
-
PerformerLookupType: string
Journey template task property type for performer.
-
PerformerValue: string
Value of the journey template task property for performer.
-
Sequence: integer
Sequence of the journey template task property.
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.
Root Schema : journeys-tasks-item-response
Type:
Show Source
object
-
ActionAddToCalendarLabel: string
Maximum Length:
120
Setting that enables to change the label of the add to calendar action. -
ActionCompleteLabel: string
Maximum Length:
120
Setting that enables to change the label of the complete action. -
ActionRejectLabel: string
Maximum Length:
120
Setting that enables to change the label of the not applicable action. -
ActionSaveLabel: string
Maximum Length:
120
Setting that enables to change the label of the save as draft action. -
ActionURL: string
Title:
URL
Maximum Length:1000
The URL associated with the task that's entered on the setup screen. To retrieve a navigable URL, use the getNavigationURL custom method of the resource. -
ActivationEligibilityProfileId: integer
(int64)
Identifier of the eligibility profile used for the activation criteria in a journey task.
-
ActivationEligibilityProfileName: string
Title:
Name
Read Only:true
Maximum Length:240
Name of the eligibility profile used for the activation criteria in a journey task. -
ActivityAction1Label: string
Maximum Length:
120
Setting that enables to change the label of action 1. -
ActivityAction2Label: string
Maximum Length:
120
Setting that enables to change the label of action 2. -
ActivityAction3Label: string
Maximum Length:
120
Setting that enables to change the label of action 3. -
ActivityAction4Label: string
Maximum Length:
120
Setting that enables to change the label of action 4. -
ActivityAction5Label: string
Maximum Length:
120
Setting that enables to change the label of action 5. -
AddToLibraryFlag: boolean
Indicates whether the task can be added to personal task library. Valid values are Yes or No. The default is No.
-
AllowAttachmentFlag: boolean
Indicates whether attachments can be added to the task. Valid values are Yes or No. The default is No.
-
AllowCommentFlag: boolean
Indicates whether comments can be added to the task. Valid values are Yes or No. The default is No.
-
AllowNotesContentFlag: boolean
Indicates whether rich content can be added for notes. Valid values are Yes or No. The default is Yes.
-
AllowNoteTitleFlag: boolean
Indicates whether the Notes title can be added. Valid values are Yes or No. The default is No.
-
AnalysisParameters: string
Maximum Length:
4000
Parameters associated with an analytics task type. -
AnalysisPath: string
Maximum Length:
1000
OTBI analysis path for an analytics task type. -
ApplicationTask: string
Title:
Application Task
Maximum Length:240
Application task type. -
ApplicationTaskName: string
Title:
Application Task
Read Only:true
Maximum Length:240
Name of application task type. -
AttachmentDocumentTypeId: integer
(int64)
Description for the AttachmentDocumentTypeId attribute in the tasks resource, which is part of the journeys root resource.
-
AttachmentDocumentTypeName: string
Title:
Document Type
Read Only:true
Maximum Length:80
Description for the AttachmentDocumentTypeName attribute in the tasks resource, which is part of the journeys root resource. -
CompletedFeedFlag: boolean
Read Only:
true
Indicates whether the atom feed is enabled when a journey task is completed. -
ConfigurableFormContext: string
Title:
Configurable Form
Maximum Length:80
Context for configurable form task type. -
ContactUserId: integer
User ID of the task performer.
-
ContactUserIdentifier: string
Maximum Length:
64
Internal identifier of the journey task performer. -
ContentProviderCode: string
Maximum Length:
240
Code of the user-defined content task. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the task. -
CreationDate: string
(date-time)
Read Only:
true
Task creation date. -
DelayDuration: integer
(int32)
Delay duration for the task.
-
DelayDurationUOM: string
Maximum Length:
30
Unit of measure used in specifying delaying the duration. -
DelayDurationUOMMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Meaning of unit of measure used in delay duration. -
DeletedFeedFlag: boolean
Read Only:
true
Indicates whether the atom feed is enabled when a journey task is deleted. -
DependentTaskId: integer
(int64)
Primary key or unique identifier of the dependent task.
-
DependentTaskName: string
Read Only:
true
Name of the dependent task. -
Description: string
Title:
Description
Maximum Length:4000
Description of the task. -
DigitalSignatureTemplateId: string
Identifier of the digital signature template.
-
DisplayFeatures: string
Task display features.
-
DisplayOptions: string
Maximum Length:
4000
Type of OTBI analysis. -
documents: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
DocumentTypeId: integer
(int64)
Title:
Document Type
Description for the document type identifier attribute. Identifier of the document type. -
DocumentTypeName: string
Title:
Document Type
Read Only:true
Maximum Length:80
Name of the document type. -
EligibilityProfileId: integer
(int64)
Title:
Eligibility Profile
Identifier of the eligibility profile. -
EligibilityProfileName: string
Title:
Name
Read Only:true
Maximum Length:240
Name of the eligibility profile. -
EmbeddedApplicationTaskCode: string
Maximum Length:
240
Code of the embedded application task. -
EmbeddedApplicationTaskTypeId: integer
(int64)
Unique identifier of the embedded application task.
-
EnableExpiryFlag: boolean
Maximum Length:
4
Indicates whether the task should expire. Valid values are Yes and No. The default value is No. -
EvaluationOffset: integer
(int32)
Number of days to consider for eligibility evaluation.
-
ExpiryDuration: integer
(int32)
Title:
Expiry Days
Duration after which the task expires. -
ExpiryRelativeTo: string
Maximum Length:
30
Criteria based on which the task expires. -
ExpiryRelativeToMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Meaning of the criteria based on which the task expires. -
FeedFlag: boolean
Read Only:
true
Indicates whether the atom feed is enabled for a journey task. -
InitiatedFeedFlag: boolean
Read Only:
true
Indicates whether the atom feed is enabled when a journey task is initiated. -
JourneyTaskId: integer
(int64)
Read Only:
true
Unique identifier of the journey task. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date on which task was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the task. -
LearnCommunityId: integer
(int64)
Identifier of the learning community.
-
LearnEnrollmentId: integer
(int64)
Identifier of the learning enrollment.
-
LearnEnrollmentType: string
Maximum Length:
80
Type of learning enrollment. -
LearningContentType: string
Maximum Length:
80
Type of learning content. -
LearningContentTypeMeaning: string
Read Only:
true
Meaning of the learning content type. -
LearningItemId: integer
(int64)
Unique identifier of the learning item.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Task Name
Maximum Length:240
Name of the journey task. -
Notes: string
(byte)
Notes for the task. The notes text is stored as a CLOB object. To use in the payload, the text should be converted to a base64 encoded string using either a conversion tool or a prerequisite script.
-
NoteTitle: string
Maximum Length:
150
Title of the notes. -
notifications: array
Notifications
Title:
Notifications
The notifications resource is a child of the tasks resource. It includes notification settings for the task performer and owner. -
OpenInSamePageFlag: boolean
Indicates whether the external URL should open in the existing page or a new page. Valid values are Yes and No. The default value is No.
-
OpenReportInSamePageFlag: boolean
Indicates whether the report should open in the existing page or a new page. Valid values are Yes and No. The default value is Yes.
-
OwnerPersonId: integer
(int64)
Internal identifier of the journey task owner.
-
OwnerResponsibilityType: string
Responsibility type of the journey task owner.
-
OwnerResponsibilityTypeMeaning: string
Read Only:
true
Responsibility type meaning of the journey task owner. -
OwnerType: string
Maximum Length:
30
Default Value:ORA_CHK_INITIATOR
Task owner type. -
OwnerTypeMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Task owner type meaning. -
OwnerUserGroupCode: string
Code of the owner user group.
-
PerformerPersonId: integer
(int64)
Internal identifier of the journey task performer.
-
PerformerResponsibilityType: string
Responsibility type of the journey task performer.
-
PerformerResponsibilityTypeMeaning: string
Read Only:
true
Responsibility type meaning of the journey task performer. -
PerformerType: string
Title:
Responsibility Type
Maximum Length:30
Default Value:ORA_WORKER
Task performer type. -
PerformerTypeMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Task performer type meaning. -
PerformerUserGroupCode: string
Code of the performer user group.
-
ProcessCloudConfiguration: string
Configuration of the process automation.
-
properties: array
Properties
Title:
Properties
The properties resource is the child of the journeys resource. It includes all the journey properties associated with the parent journey template. -
QuestionnaireId: integer
(int64)
Title:
Questionnaire
Internal identifier of the questionnaire. -
QuestionnaireName: string
Title:
Name
Read Only:true
Maximum Length:240
Name of the questionnaire. -
ReassignedFeedFlag: boolean
Read Only:
true
Indicates whether the atom feed is enabled when a journey task is reassigned. -
ReminderDuration: integer
(int32)
Duration of the task reminder.
-
ReminderRecurrence: string
Maximum Length:
30
Recurrence of the reminder. -
ReminderRelativeTo: string
Maximum Length:
30
Default Value:ORA_CHK_BFR_DUE_DT
Reminder relative to task duration. -
ReminderRelativeToMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Meaning of reminder relative to task duration. -
ReminderTemplateId: integer
(int64)
Primary key or unique identifier of the reminder notification template.
-
ReportPath: string
Title:
Report Path
Maximum Length:1000
Path to the report in BI Catalog. -
RequiredFlag: boolean
Title:
Required
Maximum Length:30
Default Value:false
Indicates whether the task is mandatory or optional. Valid values are Yes and No. Default is No. -
SaveAttachmentsToDORFor: string
Document records of person for whom to save task attachments.
-
SaveAttachmentsToDORForMeaning: string
Read Only:
true
Meaning of save attachments to document records. -
SaveDocumentsToDORFor: string
Attachments to add to document records for a document type.
-
SaveDocumentsToDORForMeaning: string
Read Only:
true
Meaning of add attachments document records. -
Sequence: integer
(int32)
Default Value:
1
Task display ordering sequence. Default is 1. -
SignatureValidationConfiguration: string
Validation type for electronic signature.
-
SourceTaskId: integer
Primary key or unique identifier of the source task.
-
Status: string
Title:
Status
Read Only:true
Maximum Length:30
Code for the task status. -
StatusMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Status of the task. -
SubType: string
Title:
Signature Type
Maximum Length:30
Task action subtype code. Available only for action types I-9 and Electronic Signature. -
SubTypeMeaning: string
Read Only:
true
Task action subtype. Available only for action types I9 and Electronic Signature. -
TargetDuration: integer
(int32)
Title:
Target Duration
Target duration for the task. -
TargetDurationUOM: string
Title:
UOM
Maximum Length:30
Unit of measure for the target duration. -
TargetDurationUOMMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Meaning of the unit of measure used in the target duration. -
TaskCode: string
Read Only:
true
Maximum Length:240
Code of a task in a journey template. -
TaskGroupId: integer
(int64)
Unique identifier of the journey task group.
-
Type: string
Title:
Task Type
Maximum Length:30
Default Value:ORA_CHK_MANUAL
Task action type code. -
TypeMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Task action type. -
VideoType: string
Maximum Length:
80
Type of video. -
VideoTypeMeaning: string
Read Only:
true
Meaning of video type. -
VideoURL: string
Maximum Length:
1000
URL of the video. -
WorkAuthorizationConfiguration: string
Work authorization for I 9 task.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Notifications
Type:
array
Title:
Notifications
The notifications resource is a child of the tasks resource. It includes notification settings for the task performer and owner.
Show Source
Nested Schema : Properties
Type:
array
Title:
Properties
The properties resource is the child of the journeys resource. It includes all the journey properties associated with the parent journey template.
Show Source
Nested Schema : journeys-tasks-documents-item-response
Type:
Show Source
object
-
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
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : journeys-tasks-notifications-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the notification. -
CreationDate: string
(date-time)
Read Only:
true
Date on which the notification was created. -
JourneyTaskNotificationId: integer
(int64)
Read Only:
true
Unique identifier of the journey task notification. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date on which the notification was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the notification. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NotifyOwnerFlag: boolean
Maximum Length:
30
Indicates if the task owner needs to be notified when the event occurs. Valid values are Yes and No. Default is No. -
NotifyPerformerFlag: boolean
Maximum Length:
30
Indicates if the task performer needs to be notified when the event occurs. Valid values are Yes and No. Default is Yes. -
OwnerExpiryTemplateId: integer
(int64)
Primary key or unique identifier of the expiry notification template for task owner.
-
OwnerForceCompleteTemplateId: integer
(int64)
Primary key or unique identifier of the force completion notification template for task owner.
-
OwnerNotApplicableTemplateId: integer
(int64)
Primary key or unique identifier of the notification template when a task is marked as not applicable for task owner.
-
OwnerTemplateId: integer
(int64)
Primary key or unique identifier of the notification template for task owner.
-
PerformerExpiryTemplateId: integer
(int64)
Primary key or unique identifier of the expiry notification template for task performer.
-
PerformerForceCompleteTemplateId: integer
(int64)
Primary key or unique identifier of the force completion notification template for task performer.
-
PerformerNotApplicableTemplateId: integer
(int64)
Primary key or unique identifier of the notification template when a task is marked as not applicable for task performer.
-
PerformerTemplateId: integer
(int64)
Primary key or unique identifier of the notification template for task performer.
-
TaskEvent: string
Maximum Length:
30
Code of the task event. Example, task initiated, task updated, task deleted, task completed. -
TaskEventMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Meaning of the task event.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : journeys-tasks-properties-item-response
Type:
Show Source
object
-
Category: string
Name of the group for journey template task property.
-
CategoryMeaning: string
Meaning of the group for journey template task property.
-
Code: string
Code of the journey template task property.
-
DisabledForLineManagerFlag: boolean
Indicates if the journey template task property is disabled for line manager. Default value depends on the task type.
-
DisabledForOthersFlag: boolean
Indicates if the journey template task property is disabled for other users. Default value depends on the task type.
-
DisabledForOwnerFlag: boolean
Indicates if the journey template task property is disabled for owner. Default value depends on the task type.
-
DisabledForPerformerFlag: boolean
Indicates if the journey template task property is disabled for performer. Default value depends on the task type.
-
Level: string
Property level for the journey template task.
-
LineManagerDefaultValue: string
Default value of the journey template task property for line manager.
-
LineManagerLookupType: string
Journey template task property type for line manager.
-
LineManagerValue: string
Value of the journey template task property for line manager.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Name of the journey template task property.
-
OthersDefaultValue: string
Default value of the journey template task property for other user.
-
OthersLookupType: string
Journey template task property type for other user.
-
OthersValue: string
Value of the journey template task property for other user.
-
OverriddenFlag: boolean
Indicates if the journey template property is overridden. Default value depends on the task type.
-
OwnerDefaultValue: string
Default value of the journey template task property for owner.
-
OwnerLookupType: string
Journey template task property type for owner.
-
OwnerValue: string
Value of the journey template task property for owner.
-
PerformerDefaultValue: string
Default value of the journey template task property for performer.
-
PerformerLookupType: string
Journey template task property type for performer.
-
PerformerValue: string
Value of the journey template task property for performer.
-
Sequence: integer
Sequence of the journey template task property.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- attachmentDocumentTypesLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: AttachmentDocumentTypeId; Target Attribute: DocumentTypeId
- Display Attribute: DocumentType, LegislationCode, Category
- documentTypesLOV
-
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/journeys/{JourneyId}/child/tasks/{JourneyTaskId}/child/documentsParameters:
- JourneyId:
$request.path.JourneyId
- JourneyTaskId2:
$request.path.JourneyTaskId2
The attachments resource is used to view, create, and update attachments. - JourneyId:
- notifications
-
Parameters:
- JourneyId:
$request.path.JourneyId
- JourneyTaskId2:
$request.path.JourneyTaskId2
The notifications resource is a child of the tasks resource. It includes notification settings for the task performer and owner. - JourneyId:
- properties
-
Operation: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId}/child/propertiesParameters:
- JourneyId:
$request.path.JourneyId
- JourneyTaskId2:
$request.path.JourneyTaskId2
The properties resource is the child of the journeys resource. It includes all the task type properties associated with the parent journey template. - JourneyId:
- reminderRelativeToLov
-
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
- finder:
- taskTypesLov
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_PER_CHK_TASK_ACTION_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: Type; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: