Jump to

• Request
• Response

Get a total compensation statement process job

get

/hcmRestApi/resources/11.13.18.05/totalCompensationStatementsProcesses/{ProcessId}

Request

Path Parameters

• ProcessId(required): integer
  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: string
  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: string
  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 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 : totalCompensationStatementsProcesses-item-response

Type: object

Show Source

• batchReportsDetails: array Total Compensation Statement Batch Report Details
  Title: Total Compensation Statement Batch Report Details

  The batchReportsDetails resource provides the ability to display total compensation statement reports details.
• batchReportsErrorDetails: array Total Compensation Statement Batch Error Details
  Title: Total Compensation Statement Batch Error Details

  The batchReportsErrorDetails resource provides the ability to display total compensation statement error details.
• batchReportsErrorSummary: array Total Compensation Statement Batch Error Summaries
  Title: Total Compensation Statement Batch Error Summaries

  The batchReportsErrorSummary resource provides the ability to display the total compensation error summary.
• batchReportsSummary: array Total Compensation Statement Batch Report Summaries
  Title: Total Compensation Statement Batch Report Summaries

  The batchReportsSummary resource provides the ability to display the total compensation statement error summary.
• childProcesses: array Total Compensation Statement Child Processes
  Title: Total Compensation Statement Child Processes

  The childProcesses resource provides the ability to display total compensation statement child processes.
• ElapsedTime: string
  Read Only: true

  Maximum Length: 27

  Elapsed time for the statement process.
• ElapsedTimeDays: string
  Read Only: true

  Elapsed days for the statement process.
• ElapsedTimeHours: string
  Read Only: true

  Elapsed hours for the statement process.
• ElapsedTimeMinutes: string
  Read Only: true

  Elapsed minutes for the statement process.
• ElapsedTimeSeconds: string
  Read Only: true

  Elapsed seconds for the statement process.
• ESSTaskId: integer (int64)
  Read Only: true

  Unique identifier of the task for the statement process.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ParentProcessId: integer (int64)
  Read Only: true

  Parent process identifier for the statement process.
• ProcessEndTime: string (date-time)
  Read Only: true

  Process end time for the statement process.
• ProcessId: integer
  Read Only: true

  Unique identifier of the statement process.
• ProcessingMode: string
  Read Only: true

  Maximum Length: 80

  Processing mode for the statement process.
• ProcessName: string
  Read Only: true

  Maximum Length: 4000

  Name of the statement process.
• ProcessStartTime: string (date-time)
  Read Only: true

  Process start time for the statement process.
• ProcessStatus: string
  Read Only: true

  Maximum Length: 80

  Process status for the statement process.
• ProcessStatusCode: integer (int64)
  Read Only: true

  Process status code for the statement process.
• Product: string
  Read Only: true

  Maximum Length: 1000

  Product associated with the statement process.
• ScheduledTime: string (date-time)
  Read Only: true

  Scheduled time for the statement process.
• StatementId: integer (int64)
  Read Only: true

  Statement identifier of the total compensation statement definition.
• StatementName: string
  Read Only: true

  Maximum Length: 255

  Name of the total compensation statement definition.
• StatementPeriodEndDate: string (date)
  Read Only: true

  End date for the total compensation statement period.
• StatementPeriodId: integer (int64)
  Read Only: true

  Period identifier for the total compensation statement period.
• StatementPeriodName: string
  Read Only: true

  Maximum Length: 255

  Name of the compensation statement person period.
• StatementPeriodStartDate: string (date)
  Read Only: true

  Start date for the total compensation statement period.
• SubmissionDate: string (date)
  Read Only: true

  Submission date for the statement process.
• SubmissionTime: string (date-time)
  Read Only: true

  Submission time for the statement process.

{
    "type":"object",
    "properties":{
        "ESSTaskId":{
            "type":"integer",
            "description":"Unique identifier of the task for the statement process.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ElapsedTime":{
            "maxLength":27,
            "type":"string",
            "description":"Elapsed time for the statement process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ElapsedTimeDays":{
            "type":"string",
            "description":"Elapsed days for the statement process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ElapsedTimeHours":{
            "type":"string",
            "description":"Elapsed hours for the statement process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ElapsedTimeMinutes":{
            "type":"string",
            "description":"Elapsed minutes for the statement process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ElapsedTimeSeconds":{
            "type":"string",
            "description":"Elapsed seconds for the statement process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ParentProcessId":{
            "type":"integer",
            "description":"Parent process identifier for the statement process.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ProcessEndTime":{
            "type":"string",
            "description":"Process end time for the statement process.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ProcessId":{
            "type":"integer",
            "description":"Unique identifier of the statement process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessName":{
            "maxLength":4000,
            "type":"string",
            "description":"Name of the statement process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessStartTime":{
            "type":"string",
            "description":"Process start time for the statement process.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ProcessStatus":{
            "maxLength":80,
            "type":"string",
            "description":"Process status for the statement process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ProcessStatusCode":{
            "type":"integer",
            "description":"Process status code for the statement process.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":38
            },
            "x-queryable":true
        },
        "ProcessingMode":{
            "maxLength":80,
            "type":"string",
            "description":"Processing mode for the statement process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Product":{
            "maxLength":1000,
            "type":"string",
            "description":"Product associated with the statement process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduledTime":{
            "type":"string",
            "description":"Scheduled time for the statement process.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StatementId":{
            "type":"integer",
            "description":"Statement identifier of the total compensation statement definition.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":4000
            },
            "x-queryable":true
        },
        "StatementName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the total compensation statement definition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StatementPeriodEndDate":{
            "type":"string",
            "description":"End date for the total compensation statement period.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StatementPeriodId":{
            "type":"integer",
            "description":"Period identifier for the total compensation statement period.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":4000
            },
            "x-queryable":true
        },
        "StatementPeriodName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the compensation statement person period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StatementPeriodStartDate":{
            "type":"string",
            "description":"Start date for the total compensation statement period.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SubmissionDate":{
            "type":"string",
            "description":"Submission date for the statement process.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmissionTime":{
            "type":"string",
            "description":"Submission time for the statement process.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "batchReportsDetails":{
            "title":"Total Compensation Statement Batch Report Details",
            "type":"array",
            "description":"The batchReportsDetails resource provides the ability to display total compensation statement reports details.",
            "items":{
                "$ref":"#/components/schemas/totalCompensationStatementsProcesses-batchReportsDetails-item-response"
            }
        },
        "batchReportsErrorDetails":{
            "title":"Total Compensation Statement Batch Error Details",
            "type":"array",
            "description":"The batchReportsErrorDetails resource provides the ability to display total compensation statement error details.",
            "items":{
                "$ref":"#/components/schemas/totalCompensationStatementsProcesses-batchReportsErrorDetails-item-response"
            }
        },
        "batchReportsErrorSummary":{
            "title":"Total Compensation Statement Batch Error Summaries",
            "type":"array",
            "description":"The batchReportsErrorSummary resource provides the ability to display the total compensation error summary.",
            "items":{
                "$ref":"#/components/schemas/totalCompensationStatementsProcesses-batchReportsErrorSummary-item-response"
            }
        },
        "batchReportsSummary":{
            "title":"Total Compensation Statement Batch Report Summaries",
            "type":"array",
            "description":"The batchReportsSummary resource provides the ability to display the total compensation statement error summary.",
            "items":{
                "$ref":"#/components/schemas/totalCompensationStatementsProcesses-batchReportsSummary-item-response"
            },
            "x-cardinality":"1"
        },
        "childProcesses":{
            "title":"Total Compensation Statement Child Processes",
            "type":"array",
            "description":"The childProcesses resource provides the ability to display total compensation statement child processes.",
            "items":{
                "$ref":"#/components/schemas/totalCompensationStatementsProcesses-childProcesses-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Total Compensation Statement Batch Report Details

Type: array

Title: Total Compensation Statement Batch Report Details

The batchReportsDetails resource provides the ability to display total compensation statement reports details.

Show Source

• Array of: object totalCompensationStatementsProcesses-batchReportsDetails-item-response

{
    "title":"Total Compensation Statement Batch Report Details",
    "type":"array",
    "description":"The batchReportsDetails resource provides the ability to display total compensation statement reports details.",
    "items":{
        "$ref":"#/components/schemas/totalCompensationStatementsProcesses-batchReportsDetails-item-response"
    }
}

Nested Schema : Total Compensation Statement Batch Error Details

Type: array

Title: Total Compensation Statement Batch Error Details

The batchReportsErrorDetails resource provides the ability to display total compensation statement error details.

Show Source

• Array of: object totalCompensationStatementsProcesses-batchReportsErrorDetails-item-response

{
    "title":"Total Compensation Statement Batch Error Details",
    "type":"array",
    "description":"The batchReportsErrorDetails resource provides the ability to display total compensation statement error details.",
    "items":{
        "$ref":"#/components/schemas/totalCompensationStatementsProcesses-batchReportsErrorDetails-item-response"
    }
}

Nested Schema : Total Compensation Statement Batch Error Summaries

Type: array

Title: Total Compensation Statement Batch Error Summaries

The batchReportsErrorSummary resource provides the ability to display the total compensation error summary.

Show Source

• Array of: object totalCompensationStatementsProcesses-batchReportsErrorSummary-item-response

{
    "title":"Total Compensation Statement Batch Error Summaries",
    "type":"array",
    "description":"The batchReportsErrorSummary resource provides the ability to display the total compensation error summary.",
    "items":{
        "$ref":"#/components/schemas/totalCompensationStatementsProcesses-batchReportsErrorSummary-item-response"
    }
}

Nested Schema : Total Compensation Statement Batch Report Summaries

Type: array

Title: Total Compensation Statement Batch Report Summaries

The batchReportsSummary resource provides the ability to display the total compensation statement error summary.

Show Source

• Array of: object totalCompensationStatementsProcesses-batchReportsSummary-item-response

{
    "title":"Total Compensation Statement Batch Report Summaries",
    "type":"array",
    "description":"The batchReportsSummary resource provides the ability to display the total compensation statement error summary.",
    "items":{
        "$ref":"#/components/schemas/totalCompensationStatementsProcesses-batchReportsSummary-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Total Compensation Statement Child Processes

Type: array

Title: Total Compensation Statement Child Processes

The childProcesses resource provides the ability to display total compensation statement child processes.

Show Source

• Array of: object totalCompensationStatementsProcesses-childProcesses-item-response

{
    "title":"Total Compensation Statement Child Processes",
    "type":"array",
    "description":"The childProcesses resource provides the ability to display total compensation statement child processes.",
    "items":{
        "$ref":"#/components/schemas/totalCompensationStatementsProcesses-childProcesses-item-response"
    }
}

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 : totalCompensationStatementsProcesses-batchReportsDetails-item-response

Type: object

Show Source

• ErrorCode: string
  Read Only: true

  Maximum Length: 30

  Code indicating whether the error code is an error or warning.
• ErrorMessage: string
  Read Only: true

  Maximum Length: 600

  Error message for the statement process report details.
• LegalEntityId: integer (int64)
  Read Only: true

  Unique identifier of the legal entity.
• LegalEntityName: string
  Read Only: true

  Maximum Length: 240

  Name of the legal entity.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PersonId: integer (int64)
  Read Only: true

  Person identifier for the worker.
• PersonName: string
  Read Only: true

  Maximum Length: 240

  Name attribute of the person name.
• PersonNumber: string
  Read Only: true

  Maximum Length: 30

  Number of the person.
• PersonPeriodId: integer (int64)
  Read Only: true

  Unique identifier of the person period.
• PersonPeriodStatementId: integer (int64)
  Read Only: true

  Unique identifier of the statement person period.
• ProcessId: integer
  Read Only: true

  Unique identifier of the statement process batch details.
• ReportDetailId: integer (int64)
  Read Only: true

  Report detail identifier of the statement process.
• SecurityAccessToUserFlag: boolean
  Read Only: true

  Indicates whether security access to statement process is granted.
• StatementGeneratedFlag: boolean
  Read Only: true

  Maximum Length: 30

  Indicates whether statements were generated.
• StatementProcessed: string
  Read Only: true

  Maximum Length: 80

  Indicates whether statements were processed.
• StatementStatusCode: string
  Read Only: true

  Maximum Length: 30

  Status code of the total compensation statement definition.
• WorkerNumber: string
  Read Only: true

  Maximum Length: 30

  Unique worker number associated with a person.

{
    "type":"object",
    "properties":{
        "ErrorCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code indicating whether the error code is an error or warning.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ErrorMessage":{
            "maxLength":600,
            "type":"string",
            "description":"Error message for the statement process report details.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LegalEntityId":{
            "type":"integer",
            "description":"Unique identifier of the legal entity.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "LegalEntityName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the legal entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PersonId":{
            "type":"integer",
            "description":"Person identifier for the worker.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PersonName":{
            "maxLength":240,
            "type":"string",
            "description":"Name attribute of the person name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number of the person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonPeriodId":{
            "type":"integer",
            "description":"Unique identifier of the person period.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PersonPeriodStatementId":{
            "type":"integer",
            "description":"Unique identifier of the statement person period.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ProcessId":{
            "type":"integer",
            "description":"Unique identifier of the statement process batch details.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReportDetailId":{
            "type":"integer",
            "description":"Report detail identifier of the statement process.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SecurityAccessToUserFlag":{
            "type":"boolean",
            "description":"Indicates whether security access to statement process is granted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StatementGeneratedFlag":{
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether statements were generated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatementProcessed":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether statements were processed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StatementStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Status code of the total compensation statement definition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkerNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Unique worker number associated with a person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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."
        }
    }
}

Nested Schema : totalCompensationStatementsProcesses-batchReportsErrorDetails-item-response

Type: object

Show Source

• CategoryName: string
  Read Only: true

  Maximum Length: 240

  Name of the category.
• ErrorCode: string
  Read Only: true

  Maximum Length: 30

  Code indicating whether the error code is an error or warning.
• ErrorDetailId: integer (int64)
  Read Only: true

  Error detail identifier for the statement process.
• ErrorMessage: string
  Read Only: true

  Maximum Length: 600

  Error message for the statement process error details.
• ItemName: string
  Read Only: true

  Maximum Length: 240

  Name of the compensation item.
• LegalEntityId: integer (int64)
  Read Only: true

  Unique identifier of the legal entity.
• LegalEntityName: string
  Read Only: true

  Maximum Length: 240

  Name of the legal entity.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PersonId: integer (int64)
  Read Only: true

  Person identifier for the worker.
• PersonName: string
  Read Only: true

  Maximum Length: 240

  Name attribute of the person name.
• PersonNumber: string
  Read Only: true

  Maximum Length: 30

  Number of the person.
• ProcessId: integer
  Read Only: true

  Unique identifier of the statement process error details.

{
    "type":"object",
    "properties":{
        "CategoryName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the category.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ErrorCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code indicating whether the error code is an error or warning.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ErrorDetailId":{
            "type":"integer",
            "description":"Error detail identifier for the statement process.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ErrorMessage":{
            "maxLength":600,
            "type":"string",
            "description":"Error message for the statement process error details.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the compensation item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LegalEntityId":{
            "type":"integer",
            "description":"Unique identifier of the legal entity.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "LegalEntityName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the legal entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PersonId":{
            "type":"integer",
            "description":"Person identifier for the worker.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PersonName":{
            "maxLength":240,
            "type":"string",
            "description":"Name attribute of the person name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number of the person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessId":{
            "type":"integer",
            "description":"Unique identifier of the statement process error details.",
            "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"
            }
        }
    }
}

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 : totalCompensationStatementsProcesses-batchReportsErrorSummary-item-response

Type: object

Show Source

• CategoryId: integer (int64)
  Read Only: true

  Unique identifier for the category.
• CategoryName: string
  Read Only: true

  Maximum Length: 240

  Name of the category.
• ErrorCode: string
  Read Only: true

  Maximum Length: 30

  Code indicating whether the error code is an error or warning.
• ErrorDetailId: integer
  Read Only: true

  Error detail identifier for the statement process error summary.
• ErrorMessage: string
  Read Only: true

  Maximum Length: 600

  Error message for the statement process error summary.
• ErrorType: string
  Read Only: true

  Maximum Length: 30

  Type name indicating whether the error is an error or warning.
• ItemId: integer (int64)
  Read Only: true

  Unique identifier of the compensation item.
• ItemName: string
  Read Only: true

  Maximum Length: 240

  Name of the compensation item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Occurrences: integer
  Read Only: true

  Number of times an error occurred in the statement process error summary.
• ProcessId: integer (int64)
  Read Only: true

  Unique identifier of the statement process error summary.

{
    "type":"object",
    "properties":{
        "CategoryId":{
            "type":"integer",
            "description":"Unique identifier for the category.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CategoryName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the category.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ErrorCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code indicating whether the error code is an error or warning.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ErrorDetailId":{
            "type":"integer",
            "description":"Error detail identifier for the statement process error summary.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ErrorMessage":{
            "maxLength":600,
            "type":"string",
            "description":"Error message for the statement process error summary.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ErrorType":{
            "maxLength":30,
            "type":"string",
            "description":"Type name indicating whether the error is an error or warning.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemId":{
            "type":"integer",
            "description":"Unique identifier of the compensation item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ItemName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the compensation item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Occurrences":{
            "type":"integer",
            "description":"Number of times an error occurred in the statement process error summary.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ProcessId":{
            "type":"integer",
            "description":"Unique identifier of the statement process error summary.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : totalCompensationStatementsProcesses-batchReportsSummary-item-response

Type: object

Show Source

• EndDate: string (date)
  Read Only: true

  End date for the statement process.
• InterimEndDate: string (date)
  Read Only: true

  Interim end date for the statement process.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NoItemValuePersons: integer (int64)
  Read Only: true

  Indicates whether a person has no item values after the statement process.
• NumberOfPersonsError: integer (int64)
  Read Only: true

  Number of errors for a person in the statement process report summary.
• NumberOfPersonsSuccess: integer (int64)
  Read Only: true

  Indicates number of persons in a successful status after the statement process.
• ProcessElapsedTime: string
  Read Only: true

  Maximum Length: 255

  Elapsed time for the statement process summary report.
• ProcessEndDate: string (date)
  Read Only: true

  Process end date for the statement process summary.
• ProcessEndTime: string
  Read Only: true

  Maximum Length: 90

  Process end time for the statement process summary.
• ProcessId: integer
  Read Only: true

  Unique identifier of the statement process report summary.
• ProcessStartDate: string (date)
  Read Only: true

  Process start date for the statement process summary.
• ProcessStartTime: string
  Read Only: true

  Maximum Length: 90

  Process start time for the statement process summary.
• StartDate: string (date)
  Read Only: true

  Start date for the statement process.
• StatementId: integer
  Read Only: true

  Statement identifier of the total compensation statement definition.
• StatementName: string
  Read Only: true

  Maximum Length: 255

  Name of the total compensation statement definition.
• StatementPeriodId: number
  Read Only: true

  Period identifier for the total compensation statement period.
• TotalPersonsProcessed: integer (int64)
  Read Only: true

  Indicates total number of persons in the statement process.
• TrialMode: string
  Read Only: true

  Maximum Length: 3

  Indicates whether trial mode was selected for the statement process.

{
    "type":"object",
    "properties":{
        "EndDate":{
            "type":"string",
            "description":"End date for the statement process.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InterimEndDate":{
            "type":"string",
            "description":"Interim end date for the statement process.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NoItemValuePersons":{
            "type":"integer",
            "description":"Indicates whether a person has no item values after the statement process.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "NumberOfPersonsError":{
            "type":"integer",
            "description":"Number of errors for a person in the statement process report summary.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "NumberOfPersonsSuccess":{
            "type":"integer",
            "description":"Indicates number of persons in a successful status after the statement process.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ProcessElapsedTime":{
            "maxLength":255,
            "type":"string",
            "description":"Elapsed time for the statement process summary report.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ProcessEndDate":{
            "type":"string",
            "description":"Process end date for the statement process summary.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ProcessEndTime":{
            "maxLength":90,
            "type":"string",
            "description":"Process end time for the statement process summary.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ProcessId":{
            "type":"integer",
            "description":"Unique identifier of the statement process report summary.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessStartDate":{
            "type":"string",
            "description":"Process start date for the statement process summary.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessStartTime":{
            "maxLength":90,
            "type":"string",
            "description":"Process start time for the statement process summary.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StartDate":{
            "type":"string",
            "description":"Start date for the statement process.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatementId":{
            "type":"integer",
            "description":"Statement identifier of the total compensation statement definition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StatementName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the total compensation statement definition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StatementPeriodId":{
            "type":"number",
            "description":"Period identifier for the total compensation statement period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "TotalPersonsProcessed":{
            "type":"integer",
            "description":"Indicates total number of persons in the statement process.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "TrialMode":{
            "maxLength":3,
            "type":"string",
            "description":"Indicates whether trial mode was selected for the statement process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : totalCompensationStatementsProcesses-childProcesses-item-response

Type: object

Show Source

• ElapsedTime: string
  Read Only: true

  Maximum Length: 27

  Elapsed time for the child processes report.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ParentProcessId: integer (int64)
  Read Only: true

  Unique identifier of the parent statement process.
• ProcessId: integer
  Read Only: true

  Unique identifier of the child statement process.
• ProcessingMode: string
  Read Only: true

  Maximum Length: 80

  Processing mode for the child statement process.
• ProcessName: string
  Read Only: true

  Maximum Length: 250

  Name of the child statement process.
• ProcessStatus: string
  Read Only: true

  Maximum Length: 80

  Process status for the child statement process.
• ProcessStatusCode: integer (int64)
  Read Only: true

  Process status code for the child statement process.
• ScheduledTime: string (date-time)
  Read Only: true

  Scheduled time for the child statement process.
• StatementId: string
  Read Only: true

  Maximum Length: 4000

  Statement identifier of the total compensation statement definition.
• StatementName: string
  Read Only: true

  Maximum Length: 255

  Name of the total compensation statement definition.
• StatementPeriodEndDate: string (date)
  Read Only: true

  End date for the total compensation statement period.
• StatementPeriodId: integer (int64)
  Read Only: true

  Period identifier for the total compensation statement period.
• StatementPeriodStartDate: string (date)
  Read Only: true

  Start date for the total compensation statement period.

{
    "type":"object",
    "properties":{
        "ElapsedTime":{
            "maxLength":27,
            "type":"string",
            "description":"Elapsed time for the child processes report.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ParentProcessId":{
            "type":"integer",
            "description":"Unique identifier of the parent statement process.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProcessId":{
            "type":"integer",
            "description":"Unique identifier of the child statement process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessName":{
            "maxLength":250,
            "type":"string",
            "description":"Name of the child statement process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ProcessStatus":{
            "maxLength":80,
            "type":"string",
            "description":"Process status for the child statement process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ProcessStatusCode":{
            "type":"integer",
            "description":"Process status code for the child statement process.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":38
            }
        },
        "ProcessingMode":{
            "maxLength":80,
            "type":"string",
            "description":"Processing mode for the child statement process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ScheduledTime":{
            "type":"string",
            "description":"Scheduled time for the child statement process.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StatementId":{
            "maxLength":4000,
            "type":"string",
            "description":"Statement identifier of the total compensation statement definition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StatementName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the total compensation statement definition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StatementPeriodEndDate":{
            "type":"string",
            "description":"End date for the total compensation statement period.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StatementPeriodId":{
            "type":"integer",
            "description":"Period identifier for the total compensation statement period.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "StatementPeriodStartDate":{
            "type":"string",
            "description":"Start date for the total compensation statement period.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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"
    }
}

Links

batchReportsDetails

Operation: /hcmRestApi/resources/11.13.18.05/totalCompensationStatementsProcesses/{ProcessId}/child/batchReportsDetails

Parameters:

• ProcessId: $request.path.ProcessId

The batchReportsDetails resource provides the ability to display total compensation statement reports details.

batchReportsErrorDetails

Operation: /hcmRestApi/resources/11.13.18.05/totalCompensationStatementsProcesses/{ProcessId}/child/batchReportsErrorDetails

Parameters:

• ProcessId: $request.path.ProcessId

The batchReportsErrorDetails resource provides the ability to display total compensation statement error details.

batchReportsErrorSummary

Operation: /hcmRestApi/resources/11.13.18.05/totalCompensationStatementsProcesses/{ProcessId}/child/batchReportsErrorSummary

Parameters:

• ProcessId: $request.path.ProcessId

The batchReportsErrorSummary resource provides the ability to display the total compensation error summary.

batchReportsSummary

Operation: /hcmRestApi/resources/11.13.18.05/totalCompensationStatementsProcesses/{ProcessId}/child/batchReportsSummary

Parameters:

• ProcessId: $request.path.ProcessId

The batchReportsSummary resource provides the ability to display the total compensation statement error summary.

childProcesses

Operation: /hcmRestApi/resources/11.13.18.05/totalCompensationStatementsProcesses/{ProcessId}/child/childProcesses

Parameters:

• ProcessId: $request.path.ProcessId

The childProcesses resource provides the ability to display total compensation statement child processes.

Back to Top