Update a conditions of approval template
patch
/fscmRestApi/resources/11.13.18.05/publicSectorConditionOfApprovalTemplates/{publicSectorConditionOfApprovalTemplatesUniqID}
Request
Path Parameters
-
publicSectorConditionOfApprovalTemplatesUniqID(required): string
This is the hash key of the attributes which make up the composite key--- AgencyId and TemplateId ---for the Conditions of Approval Templates resource and used to uniquely identify an instance of Conditions of Approval Templates. The client should not generate the hash key value. Instead, the client should query on the Conditions of Approval Templates collection resource with a filter on the primary key values in order to navigate to a specific instance of Conditions of Approval Templates.
For example: publicSectorConditionOfApprovalTemplates?q=AgencyId=<value1>;TemplateId=<value2>
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
-
COATemplateItems: array
Conditions of Approval Template Items
Title:
Conditions of Approval Template Items
The conditions of approval template item resource is used to create, update, and delete the template items used in the conditions of approval. -
Description: string
Maximum Length:
1000
The description of the template. -
EnabledFlag: string
Maximum Length:
1
Indicates if the template is enabled. -
Name: string
Maximum Length:
50
The name of the template.
Nested Schema : Conditions of Approval Template Items
Type:
array
Title:
Conditions of Approval Template Items
The conditions of approval template item resource is used to create, update, and delete the template items used in the conditions of approval.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
EnabledFlag: string
Maximum Length:
1
Indicates if the template item is enabled. -
PrintSeq: integer
(int32)
Indicates the print sequence of the condition.
-
ReorderData: string
Used to set PrintSeq for conditions. Optionally, accepts data in the given format for PATCH request. OPERATION; COAKey1: PrintSeqNum; COAKey2: PrintSeqNum; COAKey3: PrintSeqNum. Currently, OPERATION supports only the value 'REORDER'.
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 : publicSectorConditionOfApprovalTemplates-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
The unique identifier of the agency.
-
COATemplateItems: array
Conditions of Approval Template Items
Title:
Conditions of Approval Template Items
The conditions of approval template item resource is used to create, update, and delete the template items used in the conditions of approval. -
Description: string
Maximum Length:
1000
The description of the template. -
EnabledFlag: string
Maximum Length:
1
Indicates if the template is enabled. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Maximum Length:
50
The name of the template. -
TemplateId: string
Maximum Length:
20
The unique identifier of the template.
Nested Schema : Conditions of Approval Template Items
Type:
array
Title:
Conditions of Approval Template Items
The conditions of approval template item resource is used to create, update, and delete the template items used in the conditions of approval.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorConditionOfApprovalTemplates-COATemplateItems-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
The unique identifier of the agency.
-
ConditionId: string
Maximum Length:
20
The identifier of the condition that is being linked to the template. -
EnabledFlag: string
Maximum Length:
1
Indicates if the template item is enabled. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PrintSeq: integer
(int32)
Indicates the print sequence of the condition.
-
ReorderData: string
Used to set PrintSeq for conditions. Optionally, accepts data in the given format for PATCH request. OPERATION; COAKey1: PrintSeqNum; COAKey2: PrintSeqNum; COAKey3: PrintSeqNum. Currently, OPERATION supports only the value 'REORDER'.
-
TemplateId: string
Maximum Length:
20
The unique identifier of the template.
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
- COATemplateItems
-
Parameters:
- publicSectorConditionOfApprovalTemplatesUniqID:
$request.path.publicSectorConditionOfApprovalTemplatesUniqID
The conditions of approval template item resource is used to create, update, and delete the template items used in the conditions of approval. - publicSectorConditionOfApprovalTemplatesUniqID: