Jump to

• Request
• Response

Get a payroll flow checklist

get

/hcmRestApi/resources/11.13.18.05/payrollChecklists/{FlowTaskInstanceId}

Request

Path Parameters

• FlowTaskInstanceId(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:
  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.

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 : payrollChecklists-item-response

Type: object

Show Source

• Activity: string
  Read Only: true

  Maximum Length: 255

  Category of the payroll checklist.
• BaseFlowTaskId: integer
  Read Only: true

  Unique identifier for the flow task.
• ChecklistInstanceId: string
  Read Only: true

  Maximum Length: 255

  Legislative data group identifier.
• ChecklistName: string
  Read Only: true

  Maximum Length: 255

  Name of the checklist.
• DestUIURL: string
  Read Only: true

  Maximum Length: 255

  User who last updated the checklist information.
• FlowInstanceId: integer
  Read Only: true

  Unique identifier used to retrieve the submitted flow instance.
• FlowInstanceName: string
  Read Only: true

  Maximum Length: 255

  Unique identifier used to retrieve the submitted flow instance.
• FlowTaskInstanceId: integer
  Read Only: true

  Unique identifier to identify a submitted flow task instance.
• isCancellingFlag: boolean
  Read Only: true

  Indicates whether a task is undergoing cancellation, valid values are Y or N.
• isRelatedTaskFlag: boolean
  Read Only: true

  Maximum Length: 255

  Indicates whether a task is child task or not, valid values are Y or N.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 255

  User who last updated the checklist information.
• LegislationCode: string
  Read Only: true

  Maximum Length: 255

  Unique identifier to identify a status of the checklist.
• LegislativeDataGroupId: integer
  Read Only: true

  Unique identifier for the legislative data group used to retrieve the payroll flow instance.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LogLevel: string
  Read Only: true

  Maximum Length: 255

  Description of the flow parameter.
• MessageCount: string
  Read Only: true

  Maximum Length: 255

  Unique identifier used to retrieve the flow pattern.
• Owner: string
  Read Only: true

  Maximum Length: 255

  Unique identifier of the checklist owner.
• OwnerId: string
  Read Only: true

  Maximum Length: 255

  Type of a payroll flow pattern.
• OwnerType: string
  Read Only: true

  Maximum Length: 255

  Type of a group or a single checklist owner.
• OwnerTypeCode: string
  Read Only: true

  Maximum Length: 255

  Unique identifier from which the flow pattern is inherited.
• parentFlowTaskInstanceId: integer
  Read Only: true

  Unique identifier for the payroll checklists used to retrieve the payroll checklists record.
• PayrollName: string
  Read Only: true

  Maximum Length: 255

  Code that uniquely identifies the flow pattern.
• Records: string
  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.
• Status: string
  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.
• StatusCode: string
  Read Only: true

  Maximum Length: 255

  Unique identifier to identify a status of the checklist.
• SubmissionContext: string
  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.
• SubmissionDate: string (date-time)
  Read Only: true

  Date that indicates the submission of the flow instance.
• SubmittedBy: string
  Read Only: true

  Maximum Length: 255

  User who submitted the flow instance.
• SubStatus: string
  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.
• SubStatusCode: string
  Read Only: true

  Maximum Length: 255

  Unique identifier to identify a substatus of the checklist.
• TaskType: string
  Read Only: true

  Maximum Length: 255

  Task type of a flow instance, such as process, report, or task flow.
• VirtualStatus: string
  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.

{
    "type":"object",
    "properties":{
        "LegislativeDataGroupId":{
            "type":"integer",
            "description":"Unique identifier for the legislative data group used to retrieve the payroll flow instance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Owner":{
            "maxLength":"255",
            "type":"string",
            "description":"Unique identifier of the checklist owner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "parentFlowTaskInstanceId":{
            "type":"integer",
            "description":"Unique identifier for the payroll checklists used to retrieve the payroll checklists record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LegislationCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Unique identifier to identify a status of the checklist.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BaseFlowTaskId":{
            "type":"integer",
            "description":"Unique identifier for the flow task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerTypeCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Unique identifier from which the flow pattern is inherited.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Activity":{
            "maxLength":"255",
            "type":"string",
            "description":"Category of the payroll checklist.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DestUIURL":{
            "maxLength":"255",
            "type":"string",
            "description":"User who last updated the checklist information.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmissionDate":{
            "type":"string",
            "description":"Date that indicates the submission of the flow instance.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmissionContext":{
            "maxLength":"255",
            "type":"string",
            "description":"Work area from where flow is submitted, such as SRF for submit related flows, PAYROLL for Payroll work area.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Unique identifier to identify a status of the checklist.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LogLevel":{
            "maxLength":"255",
            "type":"string",
            "description":"Description of the flow parameter.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PayrollName":{
            "maxLength":"255",
            "type":"string",
            "description":"Code that uniquely identifies the flow pattern.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "VirtualStatus":{
            "maxLength":"255",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChecklistName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the checklist.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerType":{
            "maxLength":"255",
            "type":"string",
            "description":"Type of a group or a single checklist owner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FlowTaskInstanceId":{
            "type":"integer",
            "description":"Unique identifier to identify a submitted flow task instance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerId":{
            "maxLength":"255",
            "type":"string",
            "description":"Type of a payroll flow pattern.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskType":{
            "maxLength":"255",
            "type":"string",
            "description":"Task type of a flow instance, such as process, report, or task flow.",
            "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"
            }
        },
        "isRelatedTaskFlag":{
            "maxLength":"255",
            "type":"boolean",
            "description":"Indicates whether a task is child task or not, valid values are Y or N.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubStatus":{
            "maxLength":"255",
            "type":"string",
            "description":"Calculated substatus for a checklist with valid values, such as In Progress for Processing, IS_ERROR for Completed with Alerts.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Records":{
            "maxLength":"255",
            "type":"string",
            "description":"Indicates whether payroll flow pattern is a process or report or payroll flow. Valid values are Y and N.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":"255",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"255",
            "type":"string",
            "description":"User who last updated the checklist information.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "isCancellingFlag":{
            "type":"boolean",
            "description":"Indicates whether a task is undergoing cancellation, valid values are Y or N.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChecklistInstanceId":{
            "maxLength":"255",
            "type":"string",
            "description":"Legislative data group identifier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmittedBy":{
            "maxLength":"255",
            "type":"string",
            "description":"User who submitted the flow instance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FlowInstanceId":{
            "type":"integer",
            "description":"Unique identifier used to retrieve the submitted flow instance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubStatusCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Unique identifier to identify a substatus of the checklist.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FlowInstanceName":{
            "maxLength":"255",
            "type":"string",
            "description":"Unique identifier used to retrieve the submitted flow instance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageCount":{
            "maxLength":"255",
            "type":"string",
            "description":"Unique identifier used to retrieve the flow pattern.",
            "nullable":true,
            "readOnly":true,
            "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