Get all delegation rules not supported
get
/hcmRestApi/resources/11.13.18.05/businessProcessApprovalDelegationRules
Request
Query Parameters
-
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 all the delegation rules based on the identifier.
Finder Variables- PersonId; string; Identifier of the person used to retrieve the delegation rules.
- fetchRuleList Finds all the delegation rules for a specific user.
Finder Variables- pPersonId; string; Identifier of the person for whom the delegation rules need to be retrieved.
- PrimaryKey Finds all the delegation rules based on the identifier.
-
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:- Action; string; Action such as create or update that need to be performed on a specific delegation rule.
- DelegateTo; string; Identifier of the person who's being delegated.
- DelegateToDisplayName; string; Display name of the user being delegated.
- EndDate; string; End date of the delegation rule.
- Field; string; Attribute that determines if the delegation rule is based on a category or a task.
- FieldOperation; string; Type of operation to be performed to retrieve valid transactions based on the delegation rule.
- FieldValue; string; Name of the category or task associated with the delegation rule.
- IsSelfApprovalEnabled; string; Indicates if self-approval is enabled for a delegation rule. Default is No.
- PersonId; string; Identifier of the person.
- RuleId; string; Unique identifier for the delegation rule.
- RuleName; string; Name for the delegation rule.
- StartDate; string; Start date of the delegation rule.
-
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".
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 TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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.
Root Schema : businessProcessApprovalDelegationRules
Type:
Show Source
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : businessProcessApprovalDelegationRules-item-response
Type:
Show Source
object
-
Action: string
Maximum Length:
255
Action such as create or update that need to be performed on a specific delegation rule. -
DelegateTo: string
Maximum Length:
255
Identifier of the person who's being delegated. -
DelegateToDisplayName: string
Maximum Length:
255
Display name of the user being delegated. -
EndDate: string
Maximum Length:
255
End date of the delegation rule. -
Field: string
Maximum Length:
255
Attribute that determines if the delegation rule is based on a category or a task. -
FieldOperation: string
Maximum Length:
255
Type of operation to be performed to retrieve valid transactions based on the delegation rule. -
FieldValue: string
Maximum Length:
255
Name of the category or task associated with the delegation rule. -
IsSelfApprovalEnabled: string
Maximum Length:
255
Indicates if self-approval is enabled for a delegation rule. Default is No. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PersonId: string
Maximum Length:
255
Identifier of the person. -
RuleId: string
Maximum Length:
255
Unique identifier for the delegation rule. -
RuleName: string
Maximum Length:
255
Name for the delegation rule. -
StartDate: string
Maximum Length:
255
Start date of the delegation rule.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- deleteRule
-
Operation: /hcmRestApi/resources/11.13.18.05/businessProcessApprovalDelegationRules/action/deleteRuleDeletes a delegation rule based on the rule name.
- getTaskCategories
-
Operation: /hcmRestApi/resources/11.13.18.05/businessProcessApprovalDelegationRules/action/getTaskCategoriesGets a task category for approval delegation.
- hasDataPrivilege
-
Operation: /hcmRestApi/resources/11.13.18.05/businessProcessApprovalDelegationRules/action/hasDataPrivilegeGets the data privilege details for the logged in user for approval delegation.