Get all payroll flow checklists

get

/hcmRestApi/resources/11.13.18.05/payrollChecklists

Request

Query Parameters
  • 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).
  • 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
  • Used as a predefined finder to search the collection.

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables

    • PrimaryKey Finds the payroll checklists that match the specified primary key criteria.
      Finder Variables
      • FlowTaskInstanceId; integer; Unique identifier for the payroll checklists used to retrieve the payroll checklists record.
    • findByFlowInstanceId Unique identifier for the flow task instance used to retrieve the flow task instances.
      Finder Variables
      • FlowInstanceId; integer; Unique identifier for the payroll flow used to retrieve the payroll flow record.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • Activity; string; Category of the payroll checklist.
    • BaseFlowTaskId; integer; Unique identifier for the flow task.
    • ChecklistInstanceId; string; Legislative data group identifier.
    • ChecklistName; string; Name of the checklist.
    • DestUIURL; string; User who last updated the checklist information.
    • FlowInstanceId; integer; Unique identifier used to retrieve the submitted flow instance.
    • FlowInstanceName; string; Unique identifier used to retrieve the submitted flow instance.
    • FlowTaskInstanceId; integer; Unique identifier to identify a submitted flow task instance.
    • LastUpdatedBy; string; User who last updated the checklist information.
    • LegislationCode; string; Unique identifier to identify a status of the checklist.
    • LegislativeDataGroupId; integer; Unique identifier for the legislative data group used to retrieve the payroll flow instance.
    • LogLevel; string; Description of the flow parameter.
    • MessageCount; string; Unique identifier used to retrieve the flow pattern.
    • Owner; string; Unique identifier of the checklist owner.
    • OwnerId; string; Type of a payroll flow pattern.
    • OwnerType; string; Type of a group or a single checklist owner.
    • OwnerTypeCode; string; Unique identifier from which the flow pattern is inherited.
    • PayrollName; string; Code that uniquely identifies the flow pattern.
    • Records; string; Indicates whether payroll flow pattern is a process or report or payroll flow. Valid values are Y and N.
    • Status; string; Calculated status for a checklist with valid values, such as PROCESSING for Processing, C_ERRORS for Critical Errors, STOPPED for Stopped, COMPLETED for Completed, ROLLEDBACK for Full Rollback, IS_ROLLEDBACK for Rolled Back Records, IS_MFR for Marked for Retry, INCOMPLETE for Incomplete, SKIPPED for Skipped, NOT_STARTED for Not Started, CANCELED for Canceled, SCHEDULED for Scheduled, ERRORS for Errors.
    • StatusCode; string; Unique identifier to identify a status of the checklist.
    • SubStatus; string; Calculated substatus for a checklist with valid values, such as In Progress for Processing, IS_ERROR for Completed with Alerts.
    • SubStatusCode; string; Unique identifier to identify a substatus of the checklist.
    • SubmissionContext; string; Work area from where flow is submitted, such as SRF for submit related flows, PAYROLL for Payroll work area.
    • SubmissionDate; string; Date that indicates the submission of the flow instance.
    • SubmittedBy; string; User who submitted the flow instance.
    • TaskType; string; Task type of a flow instance, such as process, report, or task flow.
    • VirtualStatus; string; Calculated status for a checklist with valid values, such as PROCESSING for Processing, C_ERRORS for Critical Errors, STOPPED for Stopped, COMPLETED for Completed, ROLLEDBACK for Full Rollback, IS_ROLLEDBACK for Rolled Back Records, IS_MFR for Marked for Retry, INCOMPLETE for Incomplete, SKIPPED for Skipped, NOT_STARTED for Not Started, CANCELED for Canceled, SCHEDULED for Scheduled, ERRORS for Errors.
    • isCancellingFlag; boolean; Indicates whether a task is undergoing cancellation, valid values are Y or N.
    • isRelatedTaskFlag; boolean; Indicates whether a task is child task or not, valid values are Y or N.
    • parentFlowTaskInstanceId; integer; Unique identifier for the payroll checklists used to retrieve the payroll checklists record.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : payrollChecklists
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : payrollChecklists-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 255
    Category of the payroll checklist.
  • Read Only: true
    Unique identifier for the flow task.
  • Read Only: true
    Maximum Length: 255
    Legislative data group identifier.
  • Read Only: true
    Maximum Length: 255
    Name of the checklist.
  • Read Only: true
    Maximum Length: 255
    User who last updated the checklist information.
  • Read Only: true
    Unique identifier used to retrieve the submitted flow instance.
  • Read Only: true
    Maximum Length: 255
    Unique identifier used to retrieve the submitted flow instance.
  • Read Only: true
    Unique identifier to identify a submitted flow task instance.
  • Read Only: true
    Indicates whether a task is undergoing cancellation, valid values are Y or N.
  • Read Only: true
    Maximum Length: 255
    Indicates whether a task is child task or not, valid values are Y or N.
  • Read Only: true
    Maximum Length: 255
    User who last updated the checklist information.
  • Read Only: true
    Maximum Length: 255
    Unique identifier to identify a status of the checklist.
  • Read Only: true
    Unique identifier for the legislative data group used to retrieve the payroll flow instance.
  • Links
  • Read Only: true
    Maximum Length: 255
    Description of the flow parameter.
  • Read Only: true
    Maximum Length: 255
    Unique identifier used to retrieve the flow pattern.
  • Read Only: true
    Maximum Length: 255
    Unique identifier of the checklist owner.
  • Read Only: true
    Maximum Length: 255
    Type of a payroll flow pattern.
  • Read Only: true
    Maximum Length: 255
    Type of a group or a single checklist owner.
  • Read Only: true
    Maximum Length: 255
    Unique identifier from which the flow pattern is inherited.
  • Read Only: true
    Unique identifier for the payroll checklists used to retrieve the payroll checklists record.
  • Read Only: true
    Maximum Length: 255
    Code that uniquely identifies the flow pattern.
  • Read Only: true
    Maximum Length: 255
    Indicates whether payroll flow pattern is a process or report or payroll flow. Valid values are Y and N.
  • Read Only: true
    Maximum Length: 255
    Calculated status for a checklist with valid values, such as PROCESSING for Processing, C_ERRORS for Critical Errors, STOPPED for Stopped, COMPLETED for Completed, ROLLEDBACK for Full Rollback, IS_ROLLEDBACK for Rolled Back Records, IS_MFR for Marked for Retry, INCOMPLETE for Incomplete, SKIPPED for Skipped, NOT_STARTED for Not Started, CANCELED for Canceled, SCHEDULED for Scheduled, ERRORS for Errors.
  • Read Only: true
    Maximum Length: 255
    Unique identifier to identify a status of the checklist.
  • Read Only: true
    Maximum Length: 255
    Work area from where flow is submitted, such as SRF for submit related flows, PAYROLL for Payroll work area.
  • Read Only: true
    Date that indicates the submission of the flow instance.
  • Read Only: true
    Maximum Length: 255
    User who submitted the flow instance.
  • Read Only: true
    Maximum Length: 255
    Calculated substatus for a checklist with valid values, such as In Progress for Processing, IS_ERROR for Completed with Alerts.
  • Read Only: true
    Maximum Length: 255
    Unique identifier to identify a substatus of the checklist.
  • Read Only: true
    Maximum Length: 255
    Task type of a flow instance, such as process, report, or task flow.
  • Read Only: true
    Maximum Length: 255
    Calculated status for a checklist with valid values, such as PROCESSING for Processing, C_ERRORS for Critical Errors, STOPPED for Stopped, COMPLETED for Completed, ROLLEDBACK for Full Rollback, IS_ROLLEDBACK for Rolled Back Records, IS_MFR for Marked for Retry, INCOMPLETE for Incomplete, SKIPPED for Skipped, NOT_STARTED for Not Started, CANCELED for Canceled, SCHEDULED for Scheduled, ERRORS for Errors.
Back to Top