Create a checklist task assignment
post
/fscmRestApi/resources/11.13.18.05/hedChecklistAssignments/{hedChecklistAssignmentsUniqID}/child/checklistTaskAssignments
Request
Path Parameters
-
hedChecklistAssignmentsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Checklist Assignments resource and used to uniquely identify an instance of Checklist Assignments. The client should not generate the hash key value. Instead, the client should query on the Checklist Assignments collection resource in order to navigate to a specific instance of Checklist Assignments to get the hash key.
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
DueDate: string
(date-time)
Title:
Task Assignment Due Date
Due date. -
NotifyAssignedFlag: boolean
Maximum Length:
1
Default Value:false
Indicates to the user whether the assignee should receive a communication when the task is assigned. -
NotifyCompletedFlag: boolean
Maximum Length:
1
Default Value:false
Indicates to the user whether the assignee receives a communication upon completion of the task. -
NotifyDueFlag: boolean
Maximum Length:
1
Default Value:false
Indicates to the user whether the assignee receives a communication when the task is due. -
ReassignmentFlag: boolean
Maximum Length:
1
Default Value:false
Allow reassignment. -
StarredFlag: boolean
Maximum Length:
1
Default Value:false
Indicates if the task instance is starred, which means the user has marked it as an important task to quickly locate later. -
StatusCode: string
Title:
Task Outcome Status Code
Maximum Length:30
Default Value:ORA_HEY_STATUS_IN_PROGRESS
Status code. -
TaskId: integer
(int64)
Title:
Task Identifier
Unique identifier for the task.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : hedChecklistAssignments-checklistTaskAssignments-item-response
Type:
Show Source
object
-
CompleteFlag: boolean
Title:
Task Complete
Read Only:true
Maximum Length:1
Default Value:false
Indicates whether the task is completed. -
CompletionDate: string
(date-time)
Title:
Task Completion Date
Read Only:true
Completion date. -
DueDate: string
(date-time)
Title:
Task Assignment Due Date
Due date. -
InstructionText: string
Title:
Task Instruction Text
Read Only:true
Instructions for the task. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NotifyAssignedFlag: boolean
Maximum Length:
1
Default Value:false
Indicates to the user whether the assignee should receive a communication when the task is assigned. -
NotifyCompletedFlag: boolean
Maximum Length:
1
Default Value:false
Indicates to the user whether the assignee receives a communication upon completion of the task. -
NotifyDueFlag: boolean
Maximum Length:
1
Default Value:false
Indicates to the user whether the assignee receives a communication when the task is due. -
ReassignmentFlag: boolean
Maximum Length:
1
Default Value:false
Allow reassignment. -
StarredFlag: boolean
Maximum Length:
1
Default Value:false
Indicates if the task instance is starred, which means the user has marked it as an important task to quickly locate later. -
StartDate: string
(date-time)
Title:
Task Start Date
Read Only:true
Start date. -
StatusCode: string
Title:
Task Outcome Status Code
Maximum Length:30
Default Value:ORA_HEY_STATUS_IN_PROGRESS
Status code. -
StatusMeaning: string
Title:
Task Outcome Status
Read Only:true
Maximum Length:80
Meaning of status. -
TaskAssignmentId: integer
(int64)
Title:
Task Assignment Identifier
Read Only:true
Unique identifier for an instance of task assignment within a checklist. -
TaskCode: string
Title:
Task Code
Read Only:true
Maximum Length:50
Code for task. -
TaskDescription: string
Title:
Task Description
Read Only:true
Maximum Length:240
Description of task. -
TaskId: integer
(int64)
Title:
Task Identifier
Unique identifier for the task. -
TaskName: string
Title:
Task Name
Read Only:true
Maximum Length:50
Name of task.
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.
Links
- hedWorkflowStatusSchemesStatusesLOV
-
Parameters:
- finder:
ByStatusSchemeCodeFinder%3BStatusSchemeCode%3D{StatusSchemeCode}
The following properties are defined on the LOV link relation:- Source Attribute: StatusCode; Target Attribute: StatusCode
- Display Attribute: StatusMeaning
- finder: