Get an allocated task
get
/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}
Request
Path Parameters
-
AllocatedTaskId(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=
-
allocatedChecklistsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Allocated Checklist resource and used to uniquely identify an instance of Allocated Checklist. The client should not generate the hash key value. Instead, the client should query on the Allocated Checklist collection resource in order to navigate to a specific instance of Allocated Checklist to get the hash key.
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : allocatedChecklists-allocatedTasks-item-response
Type:
Show Source
object
-
AbsAllocatedChecklistId: integer
(int64)
Title:
Allocated Checklist Identifier
Read Only:true
Unique identifier for the parent checklist. -
ActionType: string
Read Only:
true
Maximum Length:30
Action type for the task specified in the checklist. -
ActionURL: string
Title:
URL
Maximum Length:1000
URL for the task action. -
ActualEndDate: string
(date)
Title:
Actual End Date
Date on which the allocated task ends. -
ActualStartDate: string
(date)
Title:
Actual Start Date
Date on which the allocated task starts. -
AllocatedChecklistId: integer
(int64)
Title:
Allocated Checklist Identifier
Read Only:true
Unique identifier for the allocated checklist. -
allocatedChecklistTaskFlex: array
allocatedChecklistTaskFlex
-
AllocatedTaskId: integer
(int64)
Title:
Allocated Task Identifier
Read Only:true
Unique identifier for the allocated task. -
attachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
CompletedBy: string
Title:
Completed by Person Name
Maximum Length:64
User who completed the task. -
CompletionDate: string
(date)
Title:
Completion Date
Task completion date. -
DependentOnTasks: string
Title:
Dependent on Tasks
Maximum Length:4000
Preceding task that needs to be completed. -
Description: string
Title:
Task Description
Maximum Length:4000
Description of the task. -
DetailAllocChecklistId: integer
(int64)
Title:
Allocated Step Checklist Identifier
Read Only:true
Unique identifier for the allocated enterprise onboarding step checklist. -
documents: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
FlexContextCode: string
Read Only:
true
Maximum Length:80
Descriptive flexfield for task assignment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MandatoryFlag: boolean
Title:
Required
Maximum Length:30
Indicates whether the task is mandatory or optional. Valid values are Yes and No. -
OwnerRespType: string
Title:
Owner Responsibility Type
Read Only:true
Maximum Length:30
Name of the owner responsibility type. -
OwnerRespTypeUsers: string
Title:
Owner Responsibility Type User
Read Only:true
Maximum Length:2000
User type for the owner responsibility. -
PerformerOrigSystem: string
Title:
Performer User Name
Read Only:true
Maximum Length:240
Name of system-generated performer. -
PerformerOrigSystemId: integer
(int64)
Title:
Performer Person Number
Read Only:true
System-generated identifier for the performer. -
ResponsibilityType: string
Title:
Responsibility Type
Read Only:true
Maximum Length:30
Name of the responsibility type assigned to the task. -
ResponsibilityTypeGUID: string
Title:
Responsible Person User Name
Read Only:true
Maximum Length:2000
Unique identifier for the responsibility type. -
Status: string
Title:
Status
Maximum Length:60
Status of the task. -
TargetDurationUOM: string
Title:
Target Duration UOM
Read Only:true
Maximum Length:30
Unit of measurement in days for task duration. -
TargetEndDate: string
(date)
Title:
Target End Date
End date for the task. -
TargetStartDate: string
(date)
Title:
Target Start Date
Start date for the task. -
TaskActionCode: string
Read Only:
true
Maximum Length:240
Code for the task action. -
TaskConfiguration: string
Title:
Task Configuration
Read Only:true
Maximum Length:400
Indicates whether comments and attachments are available for the task. Valid values are Yes and No. Default is No. -
TaskInChecklistId: integer
(int64)
Title:
Task Identifier
Read Only:true
Unique identifier for the task in a checklist. -
TaskName: string
Title:
Name
Maximum Length:240
Name of the task. -
TaskOwnerName: string
Title:
Owner
Read Only:true
Name of user who owns the task. -
TaskOwnerPersonId: integer
(int64)
Title:
Owner Person Number
Read Only:true
Unique identifier for the person who owns the task. -
TaskOwnerUsername: string
Title:
Owner User Name
Read Only:true
Maximum Length:240
User name of the person who owns the task. -
TaskSequence: integer
(int32)
Title:
Sequence
Read Only:true
Sequence in which the tasks are executed.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
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 : allocatedChecklists-allocatedTasks-allocatedChecklistTaskFlex-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
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 : allocatedChecklists-allocatedTasks-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
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 : allocatedChecklists-allocatedTasks-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
Links
- allocatedChecklistTaskFlex
-
Parameters:
- AllocatedTaskId:
$request.path.AllocatedTaskId
- allocatedChecklistsUniqID:
$request.path.allocatedChecklistsUniqID
- AllocatedTaskId:
- attachments
-
Parameters:
- AllocatedTaskId:
$request.path.AllocatedTaskId
- allocatedChecklistsUniqID:
$request.path.allocatedChecklistsUniqID
The attachments resource is used to view, create, and update attachments. - AllocatedTaskId:
- documents
-
Parameters:
- AllocatedTaskId:
$request.path.AllocatedTaskId
- allocatedChecklistsUniqID:
$request.path.allocatedChecklistsUniqID
The attachments resource is used to view, create, and update attachments. - AllocatedTaskId:
- reopenTask
-
Parameters:
- AllocatedTaskId:
$request.path.AllocatedTaskId
- allocatedChecklistsUniqID:
$request.path.allocatedChecklistsUniqID
Reopens an already completed or not applicable task. - AllocatedTaskId:
- updateTaskStatus
-
Parameters:
- AllocatedTaskId:
$request.path.AllocatedTaskId
- allocatedChecklistsUniqID:
$request.path.allocatedChecklistsUniqID
Updates the existing task status to complete or not applicable. - AllocatedTaskId:
Examples
The following example shows how to retrieve an allocated task by submitting a GET request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.action+json" GET http://<host>:<port>/hcmRestApi/resources/11.13.18.05/allocatedChecklists/300100031447538/child/allocatedTasks/300100031447539
Example of Response Header
The following is an example of the response header.
HTTP/1.1 200 OK Content-Type : application/vnd.oracle.adf.resourcecollection+json
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "ActionType": null, "ActionURL": null, "ActualEndDate": null, "ActualStartDate": null, "AllocatedChecklistId": 300100016023502, "AllocatedTaskId": 300100016023503, "Description": null, "TaskActionCode": null, "TaskName": "Plase order for uniform", "DependentOnTasks": null, "Status": "INI", "MandatoryFlag": true, "TaskSequence": null, "TargetEndDate": null, "TargetStartDate": "2012-12-27", "TaskOwnerName": "Brooklyn Anderson", "TaskOwnerPersonId": 100010024200642, "TaskOwnerUsername": "HR_SPEC_ALL", "ResponsibilityType": null, "ResponsibilityTypeGUID": null, "PerformerOrigSystemId": null, "PerformerOrigSystem": null, "OwnerRespType": null, "OwnerRespTypeUsers": null, "TaskInChecklistId": 300100013625539, "TaskConfiguration": null, "FlexContextCode": null, "CompletedBy": null, "CompletionDate": null, "TargetDurationUOM": null, "AbsAllocatedChecklistId": null, "DetailAllocChecklistId": null, "links": [ { ...} ] }