Create a status change record
post
/hcmRestApi/resources/11.13.18.05/statusChangeRequests/{statusRequestId}/child/statusChanges
Request
Path Parameters
-
statusRequestId(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=
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
buildingBlockId: integer
(int64)
Unique identifier for the time record associated with the status change record.
-
buildingBlockVersion: integer
(int32)
Version number for the time record stored in the WFM time repository.
-
consumerCode: string
Maximum Length:
30
Consumer code associated with the status change record, such as PJC or PYR. -
requestStatus: string
Processing status for the status change record, such as NEW, IN PROCESS, or COMPLETE.
-
statusChangeId: integer
(int64)
Unique identifier for the status change record.
-
statusCode: string
Maximum Length:
40
Default Value:A_XFR_STATUS
Status definition ID for the status change record. The default value is A_XFR_STATUS. -
statusValue: string
Maximum Length:
30
Processing status for the status change record, such as NEW, IN PROCESS, or COMPLETE.
Response
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 : statusChangeRequests-statusChanges-item-response
Type:
Show Source
object
-
buildingBlockId: integer
(int64)
Unique identifier for the time record associated with the status change record.
-
buildingBlockVersion: integer
(int32)
Version number for the time record stored in the WFM time repository.
-
consumerCode: string
Maximum Length:
30
Consumer code associated with the status change record, such as PJC or PYR. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
requestStatus: string
Processing status for the status change record, such as NEW, IN PROCESS, or COMPLETE.
-
statusChangeId: integer
(int64)
Unique identifier for the status change record.
-
statusCode: string
Maximum Length:
40
Default Value:A_XFR_STATUS
Status definition ID for the status change record. The default value is A_XFR_STATUS. -
statusValue: string
Maximum Length:
30
Processing status for the status change record, such as NEW, IN PROCESS, or COMPLETE.
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.