Update a time rule definition
patch
/fscmRestApi/resources/11.13.18.05/publicSectorIssueTypeTimeRules/{publicSectorIssueTypeTimeRulesUniqID}
Request
Path Parameters
-
publicSectorIssueTypeTimeRulesUniqID(required): string
This is the hash key of the attributes which make up the composite key--- AgencyId, DuedateTypeId and IssueTypeId ---for the Issue Type Time Rules resource and used to uniquely identify an instance of Issue Type Time Rules. The client should not generate the hash key value. Instead, the client should query on the Issue Type Time Rules collection resource with a filter on the primary key values in order to navigate to a specific instance of Issue Type Time Rules.
For example: publicSectorIssueTypeTimeRules?q=AgencyId=<value1>;DuedateTypeId=<value2>;IssueTypeId=<value3>
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AgencyId: integer
(int32)
The unique identifier for an agency.
-
DuedateTypeId: string
Maximum Length:
50
The unique identifier for a due date type. -
IssueTypeId: string
Maximum Length:
50
The unique identifier of an issue type. -
ObjectVersionNumber: integer
(int32)
Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
-
TimeRuleId: string
Maximum Length:
50
The unique identifier for a time rule.
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 : publicSectorIssueTypeTimeRules-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
The unique identifier for an 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. -
DisplaySeq: integer
(int32)
Read Only:
true
Sequence number for displaying the rows in order. -
DueDateDescription: string
Title:
Description
Read Only:true
Maximum Length:256
Description of the due date. -
DuedateTypeId: string
Maximum Length:
50
The unique identifier for a due date type. -
IssueTypeId: string
Maximum Length:
50
The unique identifier of an issue type. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time that the row was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The name of the user who last updated the row. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The session login associated with the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
-
TimeRuleId: string
Maximum Length:
50
The unique identifier for a time rule. -
TriggerDescription: string
Title:
Description
Read Only:true
Maximum Length:256
The description of the trigger for the time rule. -
TriggerId: string
Title:
Trigger ID
Read Only:true
Maximum Length:50
The unique identifier of the trigger for the time 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.