Create a set of conditions of approval
post
/fscmRestApi/resources/11.13.18.05/publicSectorConditionOfApprovals
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 unique identifier of the agency. -
CategoryId: string
Title:
Category
Maximum Length:20
The identifier of the category. -
COAConditionCompliance: array
Conditions of Approval Compliances
Title:
Conditions of Approval Compliances
The conditions od approval compliance resource is used to create, update, and delete the compliances associated with the conditions of approval. -
Condition: string
(byte)
Title:
Conditions of Approval
The actual text of the conditions of approval. -
ConditionId(required): string
Title:
Conditions of Approval ID
Maximum Length:20
The unique identifier of the condition of approval. -
ConditionType(required): string
Title:
Type
Maximum Length:12
The identifier of the condition type. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Default Value:false
Indicates if the condition is enabled. -
SubcategoryId: string
Title:
Subcategory
Maximum Length:20
The identifier of the subcategory.
Nested Schema : Conditions of Approval Compliances
Type:
array
Title:
Conditions of Approval Compliances
The conditions od approval compliance resource is used to create, update, and delete the compliances associated with the conditions of approval.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The unique identifier of the agency. -
ComplyPrdId: string
Title:
Compliance Period
Maximum Length:12
The identifier of the compliances associated with the conditions of approval. -
ConditionId: string
Title:
Conditions of Approval ID
Maximum Length:20
The unique identifier of the condition of approval. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Default Value:false
The identifier to indicate if the compliance is enabled.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
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.
Root Schema : publicSectorConditionOfApprovals-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The unique identifier of the agency. -
CategoryId: string
Title:
Category
Maximum Length:20
The identifier of the category. -
CategoryName: string
Read Only:
true
Maximum Length:50
The name of the category. -
COAConditionCompliance: array
Conditions of Approval Compliances
Title:
Conditions of Approval Compliances
The conditions od approval compliance resource is used to create, update, and delete the compliances associated with the conditions of approval. -
Compliance: string
Read Only:
true
Maximum Length:4000
The compliances associated with the conditions of approval. -
Condition: string
(byte)
Title:
Conditions of Approval
The actual text of the conditions of approval. -
ConditionId: string
Title:
Conditions of Approval ID
Maximum Length:20
The unique identifier of the condition of approval. -
ConditionPlain: string
(byte)
Title:
Conditions of Approval
Read Only:true
The text of the conditions of approval without any HTML tags. -
ConditionType: string
Title:
Type
Maximum Length:12
The identifier of the condition type. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Default Value:false
Indicates if the condition is enabled. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SubcategoryId: string
Title:
Subcategory
Maximum Length:20
The identifier of the subcategory. -
SubcategoryName: string
Read Only:
true
Maximum Length:50
The name of the subcategory. -
Type: string
Read Only:
true
Maximum Length:80
The name of the condition type.
Nested Schema : Conditions of Approval Compliances
Type:
array
Title:
Conditions of Approval Compliances
The conditions od approval compliance resource is used to create, update, and delete the compliances associated with 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 : publicSectorConditionOfApprovals-COAConditionCompliance-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The unique identifier of the agency. -
ComplyPrdId: string
Title:
Compliance Period
Maximum Length:12
The identifier of the compliances associated with the conditions of approval. -
ConditionId: string
Title:
Conditions of Approval ID
Maximum Length:20
The unique identifier of the condition of approval. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Default Value:false
The identifier to indicate if the compliance is enabled. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
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
- COAConditionCompliance
-
Parameters:
- publicSectorConditionOfApprovalsUniqID:
$request.path.publicSectorConditionOfApprovalsUniqID
The conditions od approval compliance resource is used to create, update, and delete the compliances associated with the conditions of approval. - publicSectorConditionOfApprovalsUniqID: