Create a journey task

patch

/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key for the Worker Journey Tasks resource and used to uniquely identify an instance of Worker Journey Tasks. The client should not generate the hash key value. Instead, the client should query on the Worker Journey Tasks collection resource in order to navigate to a specific instance of Worker Journey Tasks to get the hash key.
Header Parameters
  • This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
  • 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".
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
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 : 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 : 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 a child of the tasks resource. It includes display property settings for a task.
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 : tasksDFF
Type: array
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : workerJourneyTasks-learningItems-item-patch-request
Type: object
Show Source
Nested Schema : workerJourneyTasks-notifications-item-patch-request
Type: object
Show Source
  • 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.
  • 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.
Nested Schema : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
  • Title: Questionnaire Version
    Version number of the questionnaire that the participant responds to.
  • Question Responses
    Title: Question Responses
    The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.
  • 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.
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 : schema
Type: object
Show Source
  • 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.
  • Title: Comments
    Maximum Length: 4000
    Additional comments provided by the participant when responding to a question.
  • Title: Answer
    Attachment provided by the participant when responding to a question.
  • 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.
  • 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.
  • Title: Question Answer Id
    Surrogate identifier of the answer that a participant chose when responding to a single choice question.
  • 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.
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 : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : workerJourneyTasks-item-response
Type: object
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 : 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 : 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 a child of the tasks resource. It includes display property settings for a task.
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 : tasksDFF
Type: array
Show Source
Nested Schema : workerJourneyTasks-attachments-item-response
Type: object
Show Source
Nested Schema : workerJourneyTasks-documents-item-response
Type: object
Show Source
Nested Schema : workerJourneyTasks-learningItems-item-response
Type: object
Show Source
  • 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.
  • 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.
  • 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.
  • Title: eLearning Observer Type Description
    Read Only: true
    Maximum Length: 80
    Description of the e-learn observer type.
  • 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.
  • Title: eLearning Route Using Description
    Read Only: true
    Maximum Length: 80
    Description of the elearnRouteUsing.
  • Title: eLearning Time per Attempt
    Read Only: true
    Time limit per attempt on the learning content item.
  • 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.
  • 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.
  • Title: Content Type Description
    Read Only: true
    Description of the e-learn type.
  • Title: Description
    Read Only: true
    Maximum Length: 4000
    Description of the learning item.
  • Title: Content Catalog Learning Item ID
    Read Only: true
    Unique identifier for the learning content item which is the internal primary key.
  • 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.
  • Title: Content Title
    Read Only: true
    Maximum Length: 250
    Title of the learning content item.
  • Links
Nested Schema : workerJourneyTasks-notifications-item-response
Type: object
Show Source
Nested Schema : workerJourneyTasks-properties-item-response
Type: object
Show Source
Nested Schema : workerJourneyTasks-questionnaireResponses-item-response
Type: object
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 : workerJourneyTasks-questionnaireResponses-questionResponses-item-response
Type: object
Show Source
  • Title: Answer Code
    Read Only: true
    Maximum Length: 240
    The answer code that a participant chose when responding to a single choice question.
  • 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.
  • Title: Comments
    Maximum Length: 4000
    Additional comments provided by the participant when responding to a question.
  • Title: Answer
    Attachment provided by the participant when responding to a question.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    User who created the question response.
  • Title: Creation Date
    Read Only: true
    Date on which the question response was created.
  • Title: Last Update Date
    Read Only: true
    Date on which the question response was updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    User who last updated the question response.
  • Links
  • Title: Question Answer Id
    Surrogate identifier of the answer that a participant chose when responding to a single choice question.
  • Title: Question Code
    Maximum Length: 240
    Alphanumeric value that uniquely identifies a question defined for a subscriber.
  • Title: Question Id
    Surrogate identifier for the question.
  • Title: Questionnaire Question Id
    Surrogate identifier for the question in a questionnaire.
  • 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.
  • Title: Question Response Id
    Surrogate identifier for the question response.
  • Title: Question Text
    Read Only: true
    Maximum Length: 2000
    Text of the question that a participant responds to.
  • Title: Answer Score
    Read Only: true
    Calculated score for the responses provided for a question by a participant.
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 : workerJourneyTasks-questionnaireResponses-questionResponses-questionResponseAttachments-item-response
Type: object
Show Source
Nested Schema : workerJourneyTasks-tasksDFF-item-response
Type: object
Show Source
Back to Top