Get all payroll flow checklists
/hcmRestApi/resources/11.13.18.05/flowInstances/{FlowInstanceId}/child/checklists
Request
-
FlowInstanceId(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=
-
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 -
finder: string
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.
- PrimaryKey Finds the payroll checklists that match the specified primary key criteria.
-
limit: integer
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.
-
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 -
offset: integer
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.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
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
-
q: string
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:- BaseFlowTaskId; integer; Unique identifier for the flow task.
- ChecklistName; string; Name of the checklist.
- CreatedBy; string; User who created the checklist information.
- CreationDate; string; Date and time when the checklist information was created.
- FlowInstanceId; integer; Unique identifier used to retrieve the submitted flow instance.
- FlowTaskInstanceId; integer; Unique identifier to identify a submitted flow task instance.
- GroupStatus; string; High level status of a checklist, such as "Completed with error", without mentioning the specifics of the error.
- IsCancelling; string; Indicates whether the process is being canceled in the background. Valid values are Y and N. The default value is N.
- LastUpdateDate; string; Date and time when the checklist information was last updated.
- LastUpdatedBy; string; User who last updated the checklist information.
- LoggingLevel; string; Option that indicates whether a process is submitted with logging enabled.
- OwnerId; string; Unique identifier to identify a checklist owner.
- OwnerType; string; Type of a group or a single checklist owner.
- Records; number; Number of individual records successfully completed in a flow instance for a standard process.
- 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.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
-
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 TopResponse
- application/json
Default Response
-
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.
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
array
Links
object
-
BaseFlowTaskId: integer
(int64)
Unique identifier for the flow task.
-
ChecklistName: string
Read Only:
true
Maximum Length:250
Name of the checklist. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the checklist information. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the checklist information was created. -
FlowInstanceId: integer
(int64)
Read Only:
true
Unique identifier used to retrieve the submitted flow instance. -
FlowTaskInstanceId: integer
(int64)
Unique identifier to identify a submitted flow task instance.
-
GroupStatus: string
Read Only:
true
Maximum Length:255
High level status of a checklist, such as "Completed with error", without mentioning the specifics of the error. -
IsCancelling: string
Maximum Length:
2
Indicates whether the process is being canceled in the background. Valid values are Y and N. The default value is N. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the checklist information was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the checklist information. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LoggingLevel: string
Maximum Length:
80
Option that indicates whether a process is submitted with logging enabled. -
OwnerId: string
Read Only:
true
Maximum Length:4000
Unique identifier to identify a checklist owner. -
OwnerType: string
Read Only:
true
Maximum Length:18
Type of a group or a single checklist owner. -
Records: number
Number of individual records successfully completed in a flow instance for a standard process.
-
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.
array
Links
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
The following examples show how to retrieve all checklists for a flow instance by submitting a GET request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H Content-Type: application/vnd.oracle.adf.resourceitem+json -X GET https://host:port/hcmRestApi/resources/11.13.18.05/flowInstances/300100185843247/child/checklists
Example of Response Header
The following is an example of the response header.
Status: HTTP/1.1 200 OK
Content-Type: application/vnd.oracle.adf.resourceitem+json
Example of Response Body
The following example shows the contents of the response body in JSON format.
{
"items" : [ {
"FlowTaskInstanceId" : 300100185843250,
"FlowInstanceId" : 300100185843247,
"BaseFlowTaskId" : 100000021557848,
"CreatedBy" : "hcm.user@example.com",
"CreationDate" : "2019-12-11T18:33:37.149+00:00",
"LastUpdatedBy" : "hcm.user@example.com",
"LastUpdateDate" : "2022-01-11T16:27:18.971+00:00",
"LoggingLevel" : null,
"ChecklistName" : "Archive End-of-Year Payroll Results",
"OwnerId" : "100100013555209",
"OwnerType" : "USER",
"GroupStatus" : "COR_FLOWS",
"Status" : "ROLLEDBACK",
"Records" : 0,
"links" : []
{
... }
]
}
Use a Query Parameter
In this example, the query parameter ChecklistName
is used to retrieve the checklists. The following is an example of the cURL command.
curl -i -u "<username>:<password>" -H Content-Type: application/vnd.oracle.adf.resourceitem+json -X GET "https://host:port/hcmRestApi/resources/11.13.18.05/flowInstances/300100185843247/child/checklists?&q=ChecklistName=%22Archive%20End-of-Year%20Payroll%20Results%22
Example of Response Header
The following is an example of the response header.
Status: HTTP/1.1 200 OK
Content-Type: application/vnd.oracle.adf.resourceitem+json
Example of Response Body
The following example shows the contents of the response body in JSON format.
{
"items" : [ {
"FlowTaskInstanceId" : 300100185843250,
"FlowInstanceId" : 300100185843247,
"BaseFlowTaskId" : 100000021557848,
"CreatedBy" : "hcm.user@example.com",
"CreationDate" : "2019-12-11T18:33:37.149+00:00",
"LastUpdatedBy" : "hcm.user@example.com",
"LastUpdateDate" : "2022-01-11T16:27:18.971+00:00",
"LoggingLevel" : null,
"ChecklistName" : "Archive End-of-Year Payroll Results",
"OwnerId" : "100100013555209",
"OwnerType" : "USER",
"GroupStatus" : "COR_FLOWS",
"Status" : "ROLLEDBACK",
"Records" : 0,
"links" : [] {
...}
]
}