Get all time rule policies
get
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementTimeRules/{publicSectorCodeEnforcementTimeRulesUniqID}/child/TimeRulePolicy
Request
Path Parameters
-
publicSectorCodeEnforcementTimeRulesUniqID(required): string
This is the hash key of the attributes which make up the composite key--- AgencyId and TimeRuleId ---for the Time Rules resource and used to uniquely identify an instance of Time Rules. The client should not generate the hash key value. Instead, the client should query on the Time Rules collection resource with a filter on the primary key values in order to navigate to a specific instance of Time Rules.
For example: publicSectorCodeEnforcementTimeRules?q=AgencyId=<value1>;TimeRuleId=<value2>
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 -
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:- AltKey: Finds the time rule row that matches the specified search criteria.
Finder Variables:- AgencyId; integer; The key identifier of the agency for the person the row is created.
- PolicyCount; integer; The identifier of the count of the policy being configured.
- TimeRuleId; string; The key identifier of the time rule for the person the row is created.
- TimeRulePriority; string; The identifier of the priority of the time rule being set up. The priority can be Normal or High.
- TimeRuleUom; string; The identifier of the unit of measure of the time rule. It can be days or hours.
- TimeRuleUomValue; integer; The actual value of the unit of measure being configured on the time rule policy.
- AltKeyFSM: Finds the time rule row that matches the specified search criteria. This is used by the Function Setup Manager for importing and exporting the setup data.
Finder Variables:- AgencyId; integer; The key identifier of the agency for the person the row is created.
- PolicyCount; integer; The identifier of the count of the policy being configured.
- TimeRuleId; string; The key identifier of the time rule for the person the row is created.
- TimeRulePriority; string; The identifier of the priority of the time rule being set up. The priority can be Normal or High.
- PrimaryKey: Finds the time rule row that matches the specified search criteria.
Finder Variables:- AgencyId; integer; The key identifier of the agency for the person the row is created.
- PolicyKey; integer; The key identifier of the time rule policy.
- TimeRuleId; string; The key identifier of the time rule for the person the row is created.
- simpleSearchFinder: Finds the time rule row that matches the specified search criteria.
Finder Variables:- bPolicyCount; string.
- bUom; string.
- value; string; Finds the value that matches the specified search value.
- AltKey: Finds the time rule row that matches the specified search 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:- AgencyId; integer; The identifier of the public sector agency.
- CreatedBy; string; The name of the user who created the row.
- CreationDate; string; The date and time when the row was created.
- DefaultPolicy; string; Indicates if the policy is the default for the time rule.
- LastUpdateDate; string; The date and time when the row was last updated.
- LastUpdatedBy; string; The name of the user who last updated the row.
- PolicyCount; integer; Indicates the occurrence count to which the time rule priority and unit of measure apply.
- PolicyKey; integer; The unique identifier of the time rule policy.
- TimeRuleId; string; The unique identifier of the time rule definition.
- TimeRulePriority; string; Indicates the priority of the time rule policy.
- TimeRuleUom; string; Indicates the unit of measure of the time rule policy.
- TimeRuleUomValue; integer; Indicates the value of the unit of measure time rule policy.
-
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 : publicSectorCodeEnforcementTimeRules-TimeRulePolicy
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 : publicSectorCodeEnforcementTimeRules-TimeRulePolicy-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
The identifier of the public sector agency. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The name of the user who created the row. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the row was created. -
DefaultPolicy: string
Maximum Length:
1
Default Value:N
Indicates if the policy is the default for the time rule. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the row was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The name of the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PolicyCount: integer
(int32)
Title:
Policy Occurrence Count
Indicates the occurrence count to which the time rule priority and unit of measure apply. -
PolicyKey: integer
(int64)
The unique identifier of the time rule policy.
-
TimeRuleId: string
Title:
Time Rule
Maximum Length:50
The unique identifier of the time rule definition. -
TimeRulePriority: string
Title:
Priority
Maximum Length:30
Indicates the priority of the time rule policy. -
TimeRuleUom: string
Title:
Unit of Measure
Maximum Length:30
Indicates the unit of measure of the time rule policy. -
TimeRuleUomValue: integer
(int32)
Title:
Unit of Measure Value
Indicates the value of the unit of measure time rule policy.
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.