Get a task
get
/hcmRestApi/resources/11.13.18.05/tasks/{IdentificationKey}
Request
Path Parameters
-
IdentificationKey(required): string
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 -
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 : tasks-item-response
Type:
Show Source
object
-
AdditionalInformation: string
Title:
Additional Information Link
Read Only:true
Maximum Length:255
Additional Information Link -
changedAttributes: array
Changed Attributes
Title:
Changed Attributes
The changedAttributes resource is a child of the tasks resource. It includes attribute values that changed as a result of the transaction. -
IdentificationKey: string
Title:
Identification Key
Read Only:true
Maximum Length:255
Identification Key -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ModuleIdentifier: string
Title:
Module Identifier
Read Only:true
Maximum Length:60
Module Identifier
Nested Schema : Changed Attributes
Type:
array
Title:
Changed Attributes
The changedAttributes resource is a child of the tasks resource. It includes attribute values that changed as a result of the transaction.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : tasks-changedAttributes-item-response
Type:
Show Source
object
-
Attribute: string
Title:
Attribute
Read Only:true
Maximum Length:255
Attribute -
AttributeLabel: string
Read Only:
true
Maximum Length:255
Display label of the changed attribute. -
CurrentId: string
Title:
Current Value Identifier
Read Only:true
Maximum Length:255
Current Value Identifier -
CurrentValue: string
Title:
Current Value
Read Only:true
Maximum Length:255
Current Value -
DisplayFlag: boolean
Read Only:
true
Indicates whether an attribute is displayed or not. Valid values are true or false. Default value is true. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Object: string
Title:
Object
Read Only:true
Maximum Length:255
Object -
ObjectId: string
Title:
Object Identifier
Read Only:true
Maximum Length:255
Object Identifier -
ObjectMaskName: string
Read Only:
true
Maximum Length:255
Identifier for masked object name. -
ParentObject: string
Title:
Parent Object
Read Only:true
Maximum Length:255
Parent Object -
ParentObjectId: string
Title:
Parent Object Identifier
Read Only:true
Maximum Length:255
Parent Object Identifier -
ProposedId: string
Title:
Proposed Value Identifier
Read Only:true
Maximum Length:255
Proposed Value Identifier -
ProposedValue: string
Title:
Proposed Value
Read Only:true
Maximum Length:255
Proposed Value -
ShowUnchangedFlag: boolean
Read Only:
true
Indicates whether an attribute is displayed even if the value remains unchanged. Valid values are true or false. The default value is false.
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
- changedAttributes
-
Parameters:
- IdentificationKey:
$request.path.IdentificationKey
The changedAttributes resource is a child of the tasks resource. It includes attribute values that changed as a result of the transaction. - IdentificationKey:
Examples
The following example shows how to <describe action> by submitting a <method> request on the REST resource using cURL.
curl -i -u "<username>:<password>" -X GET "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/300100167792277"
Example of Response Header
The following is an example of the response header.
Status: HTTP/1.1 200 OK Content-Type: application/json
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "IdentificationKey": "300100172121370", "ModuleIdentifier": "PersonalInformation", "AdditionalInformation": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/publicWorkers/100000017099524", "links": [ { ...} ] }