Get all tasks
get
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks
Request
Path Parameters
-
WorkerJourneyId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- PrimaryKey Finds all worker journey tasks that match the primary key specified.
Finder Variables- WorkerJourneyTaskId; integer; Unique identifier of the journey task.
- findActivePhases Finds all active journey phases.
Finder Variables - findAvailableSelfTasks Finds all journey tasks except deferred tasks for the signed in user.
Finder Variables - findOthersTasks Finds all journey tasks for users other than the signed in user and journey assignee.
Finder Variables - findSelfTasks Finds all journey tasks for the signed in user.
Finder Variables - findWorkerTasks Finds all journey tasks for the journey assignee.
Finder Variables
- PrimaryKey Finds all worker journey tasks that match the primary key specified.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AuthenticationFormat; string; Password authentication format for an electronic signature task.
- JourneyTaskId; integer; Identifier of the journey task.
- LearningContentTypeMeaning; string; Meaning of the learning content type.
- Name; string; Name of the journey task.
- PerformerPersonId; integer; Person identifier of the task performer. Available only in case of single performer, is updatable when adding a new task.
- RequiredFlag; boolean; Indicates whether the task is mandatory or optional. Valid values are Yes and No. The default value is No.
- SaveAttachmentsToDORForMeaning; string; Meaning of save attachments to document records.
- Status; string; Status code of the task.
- TargetDurationUOMMeaning; string; Meaning of unit of measure used in the task target duration.
- VideoTypeMeaning; string; Meaning of video type.
- WorkerJourneyTaskId; integer; Unique identifier of the journey task.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
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 : workerJourneys-tasks
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : workerJourneys-tasks-item-response
Type:
Show Source
object
-
AccessActivity: string
Title:
Access Task
Read Only:true
Setting that determines if the signed in user can access the task. -
AccessAttachments: string
Title:
Access Attachments
Read Only:true
Setting that determines if the signed in user can access the task attachments. -
AccessComments: string
Title:
Access Comments
Read Only:true
Setting that determines if the signed in user can access the task comments. -
AccessContact: string
Title:
Access Contact Information
Read Only:true
Setting that determines if the signed in user can access the task contact details. -
AccessNotes: string
Title:
Access Notes
Read Only:true
Setting that determines if the signed in user can access the task notes. -
ActionAddToCalendar: string
Title:
Add Task to Calendar
Read Only:true
Setting that determines if the signed in user can add the task as a calendar event. -
ActionAddToCalendarLabel: string
Maximum Length:
120
Setting that enables to change the label of the add to calendar action. -
ActionComplete: string
Title:
Mark as Complete
Read Only:true
Setting that determines if the signed in user can mark a task complete. -
ActionCompleteLabel: string
Maximum Length:
120
Setting that enables to change the label of the complete action. -
ActionEdit: string
Title:
Edit
Read Only:true
Setting that determines if the signed in user can edit the task. -
ActionEditDueDate: string
Title:
Edit Due Date
Read Only:true
Setting that determines if the signed in user can edit the due date of the task. -
ActionReassign: string
Title:
Reassign
Read Only:true
Setting that determines if the signed in user can reassign the task. -
ActionReject: string
Title:
Mark as Not Applicable
Read Only:true
Setting that determines if the signed in user can mark the task as not applicable. -
ActionRejectLabel: string
Maximum Length:
120
Setting that enables to change the label of the not applicable action. -
ActionRemove: string
Title:
Remove
Read Only:true
Setting that determines if the signed in user can remove the task. -
ActionReopen: string
Title:
Reopen
Read Only:true
Setting that determines if the signed in user can reopen a completed task. -
ActionSave: string
Read Only:
true
Setting that determines if the signed in user can save an incomplete task. -
ActionSaveLabel: string
Maximum Length:
120
Setting that enables to change the label of the save as draft action. -
ActionSendReminder: string
Read Only:
true
Maximum Length:255
Setting that determines if the signed in user can send a reminder for a task. -
ActionURL: string
Title:
URL
Maximum Length:1000
URL associated with the task that's entered on the setup screen. -
ActivityAction1Label: string
Maximum Length:
120
Setting that enables to change the label of action 1. -
ActivityAction2Label: string
Maximum Length:
120
Setting that enables to change the label of action 2. -
ActivityAction3Label: string
Maximum Length:
120
Setting that enables to change the label of action 3. -
ActivityAction4Label: string
Maximum Length:
120
Setting that enables to change the label of action 4. -
ActivityAction5Label: string
Maximum Length:
120
Setting that enables to change the label of action 5. -
ActualEndDate: string
(date)
Title:
Actual End Date
Date on which the task was completed. -
ActualStartDate: string
(date)
Title:
Actual Start Date
Date on which the task was opened. -
AddAttachmentsToDORFlag: boolean
Task attachment addition to document records.
-
AddToCalendar: string
(byte)
Title:
Add to Calendar
Read Only:true
Addition of the task as a calendar event. -
AddToLibraryFlag: boolean
Task addition to personal library.
-
AllowAttachmentFlag: boolean
Indicates whether attachments are enabled for a task. Valid values are Yes or No. The default value is No.
-
AllowCommentFlag: boolean
Indicates whether comments are enabled for a task. Valid values are Yes or No. The default value is No.
-
AllowNotesContentFlag: boolean
Indicates whether rich content can be added for notes. Valid values are Yes or No. The default is Yes.
-
AllowNoteTitleFlag: boolean
Indicates whether the Notes title is hidden or not. Valid values are Yes and No. The default value is No.
-
AnalysisParameters: string
Read Only:
true
Maximum Length:4000
Parameters associated with an analytics task type. -
AnalysisPath: string
Read Only:
true
Maximum Length:1000
OTBI analysis path for an analytics task type. -
ApplicationTaskName: string
Title:
Application Task
Read Only:true
Display name of the application task -
AttachmentDocumentTypeId: integer
(int64)
Title:
Document Type for Attachments
Attachments to add to document records for the given document type. -
AttachmentDocumentTypeName: string
Title:
Document Type Name for Attachments
Read Only:true
Maximum Length:80
Attachments to add to document records for the given document type name. -
attachments: array
Candidate Attachments
Title:
Candidate Attachments
The addresses resource is the child of the recruitingUICandidates resource and provides information about the addresses of a candidate. -
AuthenticationFormat: string
Read Only:
true
Password authentication format for an electronic signature task. -
AuthenticationInstructionText: string
Title:
Password Authentication Instruction Text
Read Only:true
Instruction text used in the password authentication of an electronic signature task. -
Comments: string
Title:
Comments
Maximum Length:4000
Comments for the task. -
CompletedByDisplayName: string
Title:
Completed by Person Name
Read Only:true
Name of the person who completed the task. -
CompletedByPersonId: string
Title:
Completed by Person ID
Read Only:true
Person identifier of the person who completed the task. -
CompletedFeedFlag: boolean
Indicates whether the atom feed is enabled when a journey task is completed.
-
CompletionDate: string
(date)
Title:
Completed On
Read Only:true
End date of the task. -
ConfigurableFormContext: string
Title:
Configurable Form
Maximum Length:80
Descriptive flexfield context code for configurable form task type. -
ContentProviderCode: string
Maximum Length:
240
Code of the user-defined content task. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the task. -
CreationDate: string
(date-time)
Read Only:
true
Date on which the task was created. -
DeferredStartDate: string
(date)
Title:
Deferred Task Start Date
Deferred start date for a deferred task. -
DeletedFeedFlag: boolean
Indicates whether the atom feed is enabled when a journey task is deleted.
-
DependentTaskId: integer
(int64)
Title:
Preceding Task ID
Read Only:true
Unique identifier of the dependent task. -
DependentTaskName: string
Title:
Preceding Task
Read Only:true
Maximum Length:240
Name of the dependent task. -
Description: string
Title:
Description
Maximum Length:4000
Description of the task. -
DisplayOptions: string
Read Only:
true
Maximum Length:4000
Type of OTBI analysis. -
documents: array
Candidate Attachments
Title:
Candidate Attachments
The addresses resource is the child of the recruitingUICandidates resource and provides information about the addresses of a candidate. -
DocumentTypeId: integer
(int64)
Title:
Document Type Identifier
Identifier of the document type. -
DocumentTypeName: string
Title:
Document Type
Read Only:true
Maximum Length:80
Name of the document type. -
EmbeddedApplicationTaskCode: string
Maximum Length:
240
Code of the embedded application task. -
EmbeddedApplicationTaskTypeId: integer
(int64)
Unique identifier of the embedded application task.
-
EnableEmailFlag: boolean
Read Only:
true
Indicates whether the email field is enabled for a native electronic signature journey task. -
EnableExpiryFlag: boolean
Maximum Length:
4
Indicates whether the task should expire. Valid values are Yes and No. The default value is No. -
EnableSignatureFlag: boolean
Read Only:
true
Indicates whether the signature field is enabled for a native electronic signature journey task. -
ErrorDetails: string
Title:
Error Details
Read Only:true
Error details, if any, for the task. -
ErrorMessage: string
Title:
Error Message
Read Only:true
Error message, if any, for the task. -
ErrorType: string
Title:
Error Type
Read Only:true
Error type, if any, for the task. -
ExpiryDate: string
(date)
Date on which the journey task expires.
-
ExpiryDuration: integer
(int32)
Title:
Expiry Days
Duration after which the task expires. -
ExpiryRelativeTo: string
Maximum Length:
30
Criteria based on which the task expires. -
ExpiryRelativeToMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Meaning of the criteria based on which the task expires. -
FeedFlag: boolean
Indicates whether the atom feed is enabled for a journey task.
-
InitiatedFeedFlag: boolean
Indicates whether the atom feed is enabled when a journey task is initiated.
-
JourneyTaskId: integer
(int64)
Title:
Task Identifier
Read Only:true
Identifier of the journey task. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date on which the task was updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the task. -
LearnCommunityId: integer
(int64)
Identifier of the learning community.
-
LearnEnrollmentId: integer
(int64)
Identifier of the learning enrollment.
-
LearnEnrollmentType: string
Maximum Length:
80
Type of learning enrollment. -
LearningContentType: string
Maximum Length:
80
Type of learning content. -
LearningContentTypeMeaning: string
Read Only:
true
Meaning of the learning content type. -
LearningItemId: integer
(int64)
Unique identifier of the learning item.
-
learningItems: array
Learning Content Items List of Values
Title:
Learning Content Items List of Values
The learningContentItemsLOV resource provides a list of learning content items such as SCORM, HACP, PDF, video, assessment, and web link. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Name
Maximum Length:240
Name of the journey task. -
Notes: string
(byte)
Title:
Notes
Notes for the task. The notes text is stored as a CLOB object. To use in the payload, the text should be converted to a base64 encoded string using either a conversion tool or a prerequisite script. -
NoteTitle: string
Title:
Notes Title
Maximum Length:150
Title of the Notes section in the task. -
notifications: array
Notifications
Title:
Notifications
The notifications resource is a child of the tasks resource. It includes notification settings for the task performer and owner. -
OpenInSamePageFlag: boolean
Indicates whether the external URL should open in the existing page or a new page. Valid values are Yes and No. The default value is No.
-
OpenReportInSamePageFlag: boolean
Indicates whether the report should open in the same page is enabled for native electronic signature or report journey task.
-
OwnerName: string
Title:
Owner Name
Read Only:true
Person display name of task owner in case of single owner. Else, returns responsibility type name. -
OwnerPersonId: integer
(int64)
Title:
Owner Person ID
Person identifier of the task owner. Available only in case of single owner. -
OwnerType: string
Title:
Owner Type
Maximum Length:30
Default Value:ORA_CHK_ADHOC_USER
Task owner type. -
OwnerTypeMeaning: string
Title:
Owner
Read Only:true
Task owner type meaning. -
OwnerWorkEmailAddress: string
Title:
Email
Read Only:true
Maximum Length:240
Work email of the owner. -
ParentJourneyId: integer
(int64)
Title:
Allocated Checklist Identifier
Read Only:true
Identifier of the parent journey. -
PerformerName: string
Title:
Performer Name
Read Only:true
Person display name of task performer in case of single performer. Else, returns responsibility type name. -
PerformerPersonId: integer
(int64)
Title:
Performer Person ID
Person identifier of the task performer. Available only in case of single performer, is updatable when adding a new task. -
PerformerType: string
Title:
Performer Type
Read Only:true
Task performer type. -
PerformerTypeMeaning: string
Title:
Performer
Read Only:true
Task performer type meaning. -
properties: array
Journey Task Properties
Title:
Journey Task Properties
The properties resource is the child of the workerJourneys resource. It includes all the journey properties associated with the parent journey template. -
QuestionnaireId: integer
(int64)
Title:
Questionnaire
Internal identifier of the questionnaire. -
QuestionnaireName: string
Title:
Name
Read Only:true
Maximum Length:240
Name of the questionnaire. -
questionnaireResponses: array
Questionnaire Responses
Title:
Questionnaire Responses
The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire. -
ReassignedFeedFlag: boolean
Indicates whether the atom feed is enabled when a journey task is reassigned.
-
ReminderDuration: string
Title:
Reminder Duration
Maximum Length:30
Duration of the task reminder, that's number of days between reminders. -
ReminderRecurrence: string
Title:
Reminder Recurrence
Maximum Length:30
Reminder for task recurrence, such as the number of times the reminders need to be sent. -
ReminderRelativeTo: string
Title:
Enable Reminder
Maximum Length:30
Default Value:ORA_CHK_BFR_DUE_DT
Task reminder that's relative either to due date or start date. -
ReminderRelativeToMeaning: string
Title:
Enable Reminder Meaning
Read Only:true
Maximum Length:80
Meaning of task reminder relative to date. -
ReportPath: string
Title:
Report Path
Maximum Length:1000
Path to the report in BI Catalog. -
RequiredFlag: boolean
Title:
Required
Maximum Length:30
Indicates whether the task is mandatory or optional. Valid values are Yes and No. The default value is No. -
SaveAttachmentsToDORFor: string
Task attachment to save to document records.
-
SaveAttachmentsToDORForMeaning: string
Read Only:
true
Meaning of save attachments to document records. -
SaveDocumentsToDORFor: string
Read Only:
true
Attachments to add to document records for a document type. -
SaveDocumentsToDORForMeaning: string
Read Only:
true
Meaning of add attachments to document record. -
Sequence: integer
(int32)
Title:
Sequence
Task display ordering sequence. Default is 1. -
SignAddress: string
Title:
IP Address of Signature
Maximum Length:120
Internet protocol address where the electronic signature was provided. -
SignatureImageData: string
(byte)
Signature of the user in a native electronic signature task.
-
SignatureNameValidation: string
Read Only:
true
Validation type for name in native electronic signature. -
SignatureValidationMode: string
Title:
Signature Validation Option
Read Only:true
Validation option for an electronic signature. -
SignDate: string
(date)
Title:
Date of Signature
Read Only:true
Date on which the electronic signature was provided for an electronic signature task. -
SignerAuthentication: string
Title:
Signer Password
Authentication password of the signer in an electronic signature task. -
SignerEmail: string
Title:
Email of Signer
Maximum Length:400
Email address of the signer for an electronic signature task. -
SignerName: string
Title:
Name of Signer
Maximum Length:120
Name of the signer for an electronic signature task. -
StageJourneyId: integer
(int64)
Title:
Allocated Step Checklist Identifier
Read Only:true
Unique identifier for the journey phase. -
Status: string
Title:
Status Code
Maximum Length:60
Status code of the task. -
StatusCategory: string
Title:
Status Category
Read Only:true
Category of the task status. -
StatusMeaning: string
Title:
Status
Read Only:true
Maximum Length:80
Status of the task. -
SubType: string
Title:
Subtype Code
Maximum Length:30
Task action subtype code. Available only for I 9 and Electronic Signature task types. -
SubTypeMeaning: string
Title:
Subtype
Read Only:true
Task action subtype. Available only for I 9 and Electronic Signature task types. -
TargetDuration: integer
(int32)
Title:
Target Duration
Duration of the task. -
TargetDurationUOM: string
Title:
Target Duration UOM
Maximum Length:30
Unit of measure for the task duration, such as Days, Weeks, Months. -
TargetDurationUOMMeaning: string
Title:
Target Duration UOM Meaning
Read Only:true
Maximum Length:80
Meaning of unit of measure used in the task target duration. -
TargetEndDate: string
(date)
Title:
Target End Date
Due date of the task. -
TargetStartDate: string
(date)
Title:
Target Start Date
Expected initiation date of the task. -
TaskCompletionEnabledFlag: boolean
Indicates if the task can be completed.
-
tasksDFF: array
tasksDFF
-
Type: string
Title:
Type Code
Maximum Length:30
Code of the task action type. -
TypeMeaning: string
Title:
Type
Read Only:true
Maximum Length:80
Task action type. -
VideoType: string
Maximum Length:
80
Type of video. -
VideoTypeMeaning: string
Read Only:
true
Meaning of video type. -
VideoURL: string
Maximum Length:
1000
URL of the video. -
WorkAuthorizationProgressStatus: string
Title:
Work Authorization Status Code
Read Only:true
I 9 progress status code that displays if the I 9 process is completed. -
WorkAuthorizationProgressStatusMeaning: string
Title:
Work Authorization Status
Read Only:true
I 9 progress status that displays if the I 9 process is completed. -
WorkAuthorizationVerificationStatus: string
Title:
Work Authorization Verification Status Code
Read Only:true
I 9 verification status code. -
WorkAuthorizationVerificationStatusMeaning: string
Title:
Work Authorization Verification Status
Read Only:true
I 9 verification status. -
WorkerJourneyTaskId: integer
(int64)
Title:
Journey Task ID
Unique identifier of the journey task.
Nested Schema : Candidate Attachments
Type:
array
Title:
Candidate Attachments
The addresses resource is the child of the recruitingUICandidates resource and provides information about the addresses of a candidate.
Show Source
Nested Schema : Candidate Attachments
Type:
array
Title:
Candidate Attachments
The addresses resource is the child of the recruitingUICandidates resource and provides information about the addresses of a candidate.
Show Source
Nested Schema : Learning Content Items List of Values
Type:
array
Title:
Learning Content Items List of Values
The learningContentItemsLOV resource provides a list of learning content items such as SCORM, HACP, PDF, video, assessment, and web link.
Show Source
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 : Journey Task Properties
Type:
array
Title:
Journey Task Properties
The properties resource is the child of the workerJourneys resource. It includes all the journey properties associated with the parent journey template.
Show Source
Nested Schema : Questionnaire Responses
Type:
array
Title:
Questionnaire Responses
The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.
Show Source
Nested Schema : workerJourneys-tasks-attachments-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
Unique identifier of the attachment. System generated primary key. -
CategoryName: string
Title:
Category
Maximum Length:30
Category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
Name of the user who created the attachment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time when the attachment record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Value that indicates data type code of attachment. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Unique identifier of the attachment. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
Version number of the attachment. -
DocumentPreviewURL: string
Read Only:
true
Maximum Length:255
Attachment context. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Error status code for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Error status message for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Expiration date and time of the attachment content. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
File name of the attachment. -
FileUrl: string
Title:
File Url
URL of the attachment. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date and time when the attachment was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
User who last updated the attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Name of the user who last updated the attachment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
File content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
File length of the attachment. -
UploadedFileName: string
Title:
Uploaded File Name
File name of the attachment. -
UploadedText: string
Title:
Uploaded Text
Text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
URL of the attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
User name associated with the attachment.
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 : workerJourneys-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
Unique identifier of the attachment. System generated primary key. -
CategoryName: string
Title:
Category
Maximum Length:30
Category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
Name of the user who created the attachment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time when the attachment record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Value that indicates data type code of attachment. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Unique identifier of the attachment. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
Version number of the attachment. -
DocumentPreviewURL: string
Read Only:
true
Maximum Length:255
Attachment context. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Error status code for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Error status message for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Expiration date and time of the attachment content. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
File name of the attachment. -
FileUrl: string
Title:
File Url
URL of the attachment. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date and time when the attachment was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
User who last updated the attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Name of the user who last updated the attachment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
File content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
File length of the attachment. -
UploadedFileName: string
Title:
Uploaded File Name
File name of the attachment. -
UploadedText: string
Title:
Uploaded Text
Text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
URL of the attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
User name associated with the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : workerJourneys-tasks-learningItems-item-response
Type:
Show Source
object
-
elearnCoverArtLink: string
Title:
eLearning Cover Art Link
Read Only:true
URL of the content item's cover art. -
elearnDisableReassignObserverChecklistToAnyone: string
Title:
eLearning Disable Reassignment of the Observer Checklist to Anyone
Read Only:true
Maximum Length:1
Indicates whether the reassignment of the observer checklist to any user who isn't a configured observer, as defined on the learning item, is disabled. Valid values are Y, N for the observation checklist e-learn type. Default value is Y. -
elearnDisableSelfAssessChecklist: string
Title:
eLearning Disable Self-Assessment Checklist
Read Only:true
Maximum Length:1
Indicates whether the self-assessment checklist for the observation checklist is disabled. Valid values are Y, N for the observation checklist elearnType. Default value is Y. -
elearnObserverType: string
Title:
eLearning Observer Type
Read Only:true
Maximum Length:30
Type of observer for the observation checklist e-learn type such as Individuals or Representative. Valid values are defined in the list ELearnObserverTypeLOV. -
elearnObserverTypeMeaning: string
Title:
eLearning Observer Type Description
Read Only:true
Maximum Length:80
Description of the e-learn observer type. -
elearnRichMediaLink: string
Title:
eLearning Rich Media Link
Read Only:true
URL to open the rich media directly from the browser. -
elearnRouteUsing: string
Title:
eLearning Route Using
Read Only:true
Maximum Length:30
Approval routes for the observation checklist e-learn type. Valid values are defined in the list ELearnRouteUsingLOV. -
elearnRouteUsingMeaning: string
Title:
eLearning Route Using Description
Read Only:true
Maximum Length:80
Description of the elearnRouteUsing. -
elearnTimePERAttempt: number
Title:
eLearning Time per Attempt
Read Only:true
Time limit per attempt on the learning content item. -
elearnTimePERAttemptUnits: string
Title:
eLearning Time per Attempt Units
Read Only:true
Maximum Length:30
Units for time limit per attempt on the learning content item such as Hour, or Minute. Valid values are defined in the list ELearnTimePerAttemptUnitsLOV. -
elearnType: string
Title:
Content Type
Read Only:true
Maximum Length:30
Type of self-paced learning such as Video or SCORM. Valid values are defined in the list ContentTypeLOV. -
elearnTypeMeaning: string
Title:
Content Type Description
Read Only:true
Description of the e-learn type. -
learningItemDescription: string
Title:
Description
Read Only:true
Maximum Length:4000
Description of the learning item. -
learningItemId: integer
(int64)
Title:
Content Catalog Learning Item ID
Read Only:true
Unique identifier for the learning content item which is the internal primary key. -
learningItemNumber: string
Title:
Content Number
Read Only:true
Maximum Length:30
User-friendly number identifying the learning content item. It's a surrogate key which is shown in the UI. -
learningItemTitle: string
Title:
Content Title
Read Only:true
Maximum Length:250
Title of the learning content item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : workerJourneys-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. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date on which the notification was updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the notification -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NotifyOwnerFlag: boolean
Title:
Notify Owner
Maximum Length:30
Indicates whether the task owner needs to be notified when the event occurs. Valid values are Yes and No. The default value is No. -
NotifyPerformerFlag: boolean
Title:
Notify Performer
Maximum Length:30
Indicates whether the task performer needs to be notified when the event occurs. Valid values are Yes and No. The default value is Yes. -
TaskEvent: string
Title:
Task Event Code
Maximum Length:30
Code of the task event. For example, task initiated, task updated, task deleted, task completed. -
TaskEventMeaning: string
Title:
Task Event
Read Only:true
Maximum Length:80
Meaning of the task event. -
WorkerJourneyTaskNotificationId: integer
(int64)
Title:
Journey Task Notification ID
Unique identifier of the journey task notification.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : workerJourneys-tasks-properties-item-response
Type:
Show Source
object
-
Category: string
Name of the group for journey template task property.
-
CategoryMeaning: string
Meaning of group for journey template task property.
-
Code: string
Property code of journey template task.
-
DisabledForLineManagerFlag: boolean
Indicates if journey template task property is disabled for line manager. Default value depends on the task type.
-
DisabledForOthersFlag: boolean
Indicates if the journey template task property is disabled for other users. Default value depends on the task type.
-
DisabledForOwnerFlag: boolean
Indicates if the journey template task property is disabled for owner. Default value depends on the task type.
-
DisabledForPerformerFlag: boolean
Indicates if the journey template task property is disabled for performer. Default value depends on the task type.
-
Level: string
Property level for the journey template task.
-
LineManagerDefaultValue: string
Default value of the journey template task property for line manager.
-
LineManagerLookupType: string
Journey template task property for performer. Lookup type of the journey template task property for line manager.
-
LineManagerValue: string
Value of the journey template task property for line manager.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Name of the journey template task property.
-
OthersDefaultValue: string
Default value of the journey template task property for other user.
-
OthersLookupType: string
Journey template task property type for other user.
-
OthersValue: string
Property value of the journey template task for other user.
-
OverriddenFlag: boolean
Indicates if the journey template property is overridden. Default value depends on the task type.
-
OwnerDefaultValue: string
Default value of the journey template task property for owner.
-
OwnerLookupType: string
Journey template task property type for owner.
-
OwnerValue: string
Property value of the journey template task for owner.
-
PerformerDefaultValue: string
Default value of the journey template task property for performer.
-
PerformerLookupType: string
Journey template task property for performer.
-
PerformerValue: string
Property value of the journey template task for performer.
-
Sequence: integer
Sequence of the journey template task property.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : workerJourneys-tasks-questionnaireResponses-item-response
Type:
Show Source
object
-
AttemptNumber: integer
(int64)
Title:
Attempt Number
Read Only:true
The attempt number of a participant when responding to a questionnaire. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the questionnaire response. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date on which the questionnaire response was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Date on which the questionnaire response was updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who last updated the questionnaire response. -
LatestAttemptFlag: boolean
Title:
Latest Attempt
Read Only:true
Maximum Length:30
Default Value:false
Indicates if the response is the latest attempt by a participant to the questionnaire. This is a read-only attribute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
QuestionnaireParticipantId: integer
(int64)
Title:
Questionnaire Participant Id
Surrogate identifier for the questionnaire participant. -
QuestionnaireResponseId: integer
(int64)
Title:
Questionnaire Response Id
Surrogate identifier for the questionnaire response. -
QuestionnaireVersionNumber: integer
(int64)
Title:
Questionnaire Version
Version number of the questionnaire that the participant responds to. -
questionResponses: array
Question Responses
Title:
Question Responses
The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire. -
Status: string
Title:
Response Status Code
Maximum Length:30
Status of the questionnaire response. I denotes the response is in progress and not submitted yet, while S denotes a submitted response. -
StatusMeaning: string
Title:
Response Status
Read Only:true
Maximum Length:80
Meaning of the status code. -
SubmittedDateTime: string
(date)
Title:
Submitted Time
Read Only:true
Date on which the questionnaire response was submitted. -
TotalScore: number
Title:
Total Score
Read Only:true
Total score for the responses submitted by a participant for a questionnaire.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Question Responses
Type:
array
Title:
Question Responses
The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.
Show Source
Nested Schema : workerJourneys-tasks-questionnaireResponses-questionResponses-item-response
Type:
Show Source
object
-
AnswerCode: string
Title:
Answer Code
Read Only:true
Maximum Length:240
The answer code that a participant chose when responding to a single choice question. -
AnswerCodeList: string
Title:
Answer Code List
Concatenated list of answer choices, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question. -
AnswerComments: string
Title:
Comments
Maximum Length:4000
Additional comments provided by the participant when responding to a question. -
AnswerLargeObject: string
(byte)
Title:
Answer
Attachment provided by the participant when responding to a question. -
AnswerList: string
Title:
Answer List
Maximum Length:2000
Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question. -
AnswerShortdescription: string
Title:
Answer Short Description
Read Only:true
Maximum Length:240
Text of the answer chosen by a participant when responding to a single choice question. -
AnswerShortDescriptionList: string
Title:
Answer Short Description
Read Only:true
Concatenated list of answer texts, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question. -
ChoiceCodeList: string
Title:
Choice List Code
Concatenated list of answer codes, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses. -
ChoiceList: string
Title:
Choice List
Maximum Length:2000
Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses. -
ChoiceShortDescription: string
Title:
Choice Short Description
Read Only:true
Concatenated list of answer texts, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the question response. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date on which the question response was created. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date on which the question response was updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who last updated the question response. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
QuestionAnswerId: integer
(int64)
Title:
Question Answer Id
Surrogate identifier of the answer that a participant chose when responding to a single choice question. -
QuestionCode: string
Title:
Question Code
Maximum Length:240
Alphanumeric value that uniquely identifies a question defined for a subscriber. -
QuestionId: integer
(int64)
Title:
Question Id
Surrogate identifier for the question. -
QuestionnaireQuestionId: integer
(int64)
Title:
Questionnaire Question Id
Surrogate identifier for the question in a questionnaire. -
questionResponseAttachments: array
Question Response Attachments
Title:
Question Response Attachments
The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question. -
QuestionResponseId: integer
(int64)
Title:
Question Response Id
Surrogate identifier for the question response. -
QuestionText: string
Title:
Question Text
Read Only:true
Maximum Length:2000
Text of the question that a participant responds to. -
Score: integer
(int64)
Title:
Answer Score
Read Only:true
Calculated score for the responses provided for a question by a participant.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Question Response Attachments
Type:
array
Title:
Question Response Attachments
The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
Show Source
Nested Schema : workerJourneys-tasks-questionnaireResponses-questionResponses-questionResponseAttachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided exclusively for the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
Category name of the attachment. This is a read-only attribute. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
User name of the user who created the attachment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date on which the attachment was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Attachment type supported for the question. Only the attachment type, FILE, is supported. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Surrogate identifier of the document attached to the questionnaire. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Path of the folder. -
DmVersionNumber: string
Maximum Length:
255
Version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Error status code of the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Error status message of the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Expiration date of the attachment. This is a read-only attribute. -
FileContents: string
(byte)
Title:
File Contents
File contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
Name of the attachment file. -
FileUrl: string
Title:
File Url
File URL of the attachment. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date on which the attachment was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
User who last updated the attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Name of the user who last updated the attachment record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the uploaded file. This is a read-only attribute. -
UploadedFileLength: integer
Title:
File Size
Size of the uploaded file. This is a read-only attribute. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the uploaded file. This is a read-only attribute. -
UploadedText: string
Title:
Uploaded Text
Text uploaded in the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI of the attachment. This is a read-only attribute. -
Url: string
Title:
Url
Maximum Length:4000
URL of a web page attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
User name of the person who uploaded the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : workerJourneys-tasks-tasksDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
AllocatedTaskId: integer
(int64)
Title:
Allocated Task Identifier
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source