Create a set of time rule definitions
post
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementTimeRules
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The identifier of the public sector agency. -
Classification(required): string
Maximum Length:
50
The classification of the time rule. -
DeletedFlag: string
Maximum Length:
1
Default Value:N
Indicates that the row of data has been deleted. -
Description(required): string
Title:
Description
Maximum Length:256
The description of the time rule. -
DueDtTypeId(required): string
Title:
Due Date Type
Maximum Length:50
The unique identifier of the due date type definition. -
EnabledFlag: string
Title:
Enabled
Maximum Length:1
Default Value:Y
Indicates if the time rule definition is available for use. -
SeedDataLock: integer
(int32)
Default Value:
0
Indicates that the row of data has been disabled for editing. -
TimeRuleId(required): string
Title:
Time Rule
Maximum Length:50
The unique identifier of the time rule definition. -
TimeRulePolicy: array
Time Rule Policies
Title:
Time Rule Policies
The time rule policies resource is used to configure the time rule policies for use in the time rule definitions.
Nested Schema : Time Rule Policies
Type:
array
Title:
Time Rule Policies
The time rule policies resource is used to configure the time rule policies for use in the time rule definitions.
Show Source
Nested Schema : publicSectorCodeEnforcementTimeRules-TimeRulePolicy-item-post-request
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
The identifier of the public sector agency. -
DefaultPolicy: string
Maximum Length:
1
Default Value:N
Indicates if the policy is the default for the time rule. -
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.
Response
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-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The identifier of the public sector agency. -
Classification: string
Maximum Length:
50
The classification of the time rule. -
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. -
DeletedFlag: string
Maximum Length:
1
Default Value:N
Indicates that the row of data has been deleted. -
Description: string
Title:
Description
Maximum Length:256
The description of the time rule. -
DueDtTypeId: string
Title:
Due Date Type
Maximum Length:50
The unique identifier of the due date type definition. -
EnabledFlag: string
Title:
Enabled
Maximum Length:1
Default Value:Y
Indicates if the time rule definition is available for use. -
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. -
SeedDataLock: integer
(int32)
Default Value:
0
Indicates that the row of data has been disabled for editing. -
TimeRuleId: string
Title:
Time Rule
Maximum Length:50
The unique identifier of the time rule definition. -
TimeRulePolicy: array
Time Rule Policies
Title:
Time Rule Policies
The time rule policies resource is used to configure the time rule policies for use in the time rule definitions.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Time Rule Policies
Type:
array
Title:
Time Rule Policies
The time rule policies resource is used to configure the time rule policies for use in the time rule definitions.
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.
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
Links
- TimeRulePolicy
-
Parameters:
- publicSectorCodeEnforcementTimeRulesUniqID:
$request.path.publicSectorCodeEnforcementTimeRulesUniqID
The time rule policies resource is used to configure the time rule policies for use in the time rule definitions. - publicSectorCodeEnforcementTimeRulesUniqID: