Update a person total compensation statement
patch
/hcmRestApi/resources/11.13.18.05/totalCompensationPersonStatements/{PersonPeriodStatementId}
Request
Path Parameters
-
PersonPeriodStatementId(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
-
StatementViewedDate: string
(date-time)
Date on which the person total compensation statement was viewed.
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 : totalCompensationPersonStatements-item-response
Type:
Show Source
object
-
AssignmentId: integer
(int64)
Read Only:
true
Assignment identifier for the person assignment. -
LegalEntityId: integer
(int64)
Read Only:
true
Unique identifier for the legal employer of the person total compensation statement. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PeriodRunId: integer
(int64)
Read Only:
true
Unique identifier for the period run of the person total compensation statement. -
PersonId: integer
(int64)
Read Only:
true
Unique identifier for the person of the total compensation statement. -
PersonPeriodId: integer
(int64)
Read Only:
true
Unique identifier for the person period of the total compensation statement. -
PersonPeriodStatementId: integer
(int64)
Read Only:
true
Unique identifier for the total compensation person period statement. -
StatementPeriodAvailabilityDate: string
(date)
Title:
Date Available to Workers
Read Only:true
Availability date of the person total compensation statement. -
StatementPeriodEndDate: string
(date)
Read Only:
true
End date of the person total compensation statement period. -
StatementPeriodId: integer
(int64)
Read Only:
true
Period identifier for the total compensation statement period. -
StatementPeriodStartDate: string
(date-time)
Read Only:
true
Start date of the person total compensation statement period. -
StatementViewedDate: string
(date-time)
Date on which the person total compensation statement was viewed.
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.