Jump to

• Request
• Response

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• StatementViewedDate: string (date-time)
  Date on which the person total compensation statement was viewed.

{
    "type":"object",
    "properties":{
        "StatementViewedDate":{
            "type":"string",
            "description":"Date on which the person total compensation statement was viewed.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Back to Top

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.

Body ()

Root Schema : totalCompensationPersonStatements-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "StatementPeriodStartDate":{
            "type":"string",
            "description":"Start date of the person total compensation statement period.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PersonId":{
            "type":"integer",
            "description":"Unique identifier for the person of the total compensation statement.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StatementPeriodEndDate":{
            "type":"string",
            "description":"End date of the person total compensation statement period.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PersonPeriodStatementId":{
            "type":"integer",
            "description":"Unique identifier for the total compensation person period statement.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LegalEntityId":{
            "type":"integer",
            "description":"Unique identifier for the legal employer of the person total compensation statement.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "AssignmentId":{
            "type":"integer",
            "description":"Assignment identifier for the person assignment.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "StatementPeriodAvailabilityDate":{
            "title":"Date Available to Workers",
            "type":"string",
            "description":"Availability date of the person total compensation statement.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "StatementViewedDate":{
            "type":"string",
            "description":"Date on which the person total compensation statement was viewed.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "PeriodRunId":{
            "type":"integer",
            "description":"Unique identifier for the period run of the person total compensation statement.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "StatementPeriodId":{
            "type":"integer",
            "description":"Period identifier for the total compensation statement period.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PersonPeriodId":{
            "type":"integer",
            "description":"Unique identifier for the person period of the total compensation statement.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top