Create status change requests
post
/hcmRestApi/resources/11.13.18.05/statusChangeRequests
Request
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
-
requestNumber(required): string
Maximum Length:
80
External request number defined by the time consumer application, such as payroll or projects. -
requestStatus: string
Aggregate status of the current request returned by the application.
-
requestTimestamp(required): string
Maximum Length:
80
Timestamp for the status change request. -
sourceId(required): string
Maximum Length:
40
Identifier for the source. -
statusChanges: array
Status Changes
Title:
Status Changes
The statusChanges resource is a unique identifier for a status change record sent using the status changes REST API. It corresponds to a time record in the WFM time repository. It's a single record expressed as time buildingBlockId and time buildingBlockVersion, along with the associated attribution that details the type of work completed, such as regular or overtime. -
statusRequestId: integer
(int64)
Unique identifier for the status change request.
Nested Schema : Status Changes
Type:
array
Title:
Status Changes
The statusChanges resource is a unique identifier for a status change record sent using the status changes REST API. It corresponds to a time record in the WFM time repository. It's a single record expressed as time buildingBlockId and time buildingBlockVersion, along with the associated attribution that details the type of work completed, such as regular or overtime.
Show Source
Nested Schema : statusChangeRequests-statusChanges-item-post-request
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-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
requestNumber: string
Maximum Length:
80
External request number defined by the time consumer application, such as payroll or projects. -
requestStatus: string
Aggregate status of the current request returned by the application.
-
requestTimestamp: string
Maximum Length:
80
Timestamp for the status change request. -
sourceId: string
Maximum Length:
40
Identifier for the source. -
statusChanges: array
Status Changes
Title:
Status Changes
The statusChanges resource is a unique identifier for a status change record sent using the status changes REST API. It corresponds to a time record in the WFM time repository. It's a single record expressed as time buildingBlockId and time buildingBlockVersion, along with the associated attribution that details the type of work completed, such as regular or overtime. -
statusRequestId: integer
(int64)
Unique identifier for the status change request.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Status Changes
Type:
array
Title:
Status Changes
The statusChanges resource is a unique identifier for a status change record sent using the status changes REST API. It corresponds to a time record in the WFM time repository. It's a single record expressed as time buildingBlockId and time buildingBlockVersion, along with the associated attribution that details the type of work completed, such as regular or overtime.
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 : 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
Links
- statusChanges
-
Operation: /hcmRestApi/resources/11.13.18.05/statusChangeRequests/{statusRequestId}/child/statusChangesParameters:
- statusRequestId:
$request.path.statusRequestId
The statusChanges resource is a unique identifier for a status change record sent using the status changes REST API. It corresponds to a time record in the WFM time repository. It's a single record expressed as time buildingBlockId and time buildingBlockVersion, along with the associated attribution that details the type of work completed, such as regular or overtime. - statusRequestId: