Jump to

• Request
• Response

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "COATemplateItems":{
            "title":"Conditions of Approval Template Items",
            "type":"array",
            "description":"The conditions of approval template item resource is used to create, update, and delete the template items used in the conditions of approval.",
            "items":{
                "$ref":"#/components/schemas/publicSectorConditionOfApprovalTemplates-COATemplateItems-item-patch-request"
            }
        },
        "Description":{
            "maxLength":"1000",
            "type":"string",
            "description":"The description of the template.",
            "nullable":true
        },
        "EnabledFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if the template is enabled.",
            "nullable":false
        },
        "Name":{
            "maxLength":"50",
            "type":"string",
            "description":"The name of the template.",
            "nullable":false
        }
    }
}

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

• Array of: object schema

{
    "title":"Conditions of Approval Template Items",
    "type":"array",
    "description":"The conditions of approval template item resource is used to create, update, and delete the template items used in the conditions of approval.",
    "items":{
        "$ref":"#/components/schemas/publicSectorConditionOfApprovalTemplates-COATemplateItems-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• 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'.

{
    "type":"object",
    "properties":{
        "ReorderData":{
            "type":"string",
            "description":"Used to set PrintSeq for conditions. Optionally, accepts data in the given format for PATCH request. \nOPERATION; COAKey1: PrintSeqNum; COAKey2: PrintSeqNum; COAKey3: PrintSeqNum. Currently, OPERATION supports only the value 'REORDER'.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "EnabledFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if the template item is enabled.",
            "nullable":false
        },
        "PrintSeq":{
            "type":"integer",
            "description":"Indicates the print sequence of the condition.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"3"
            }
        }
    }
}

Back to Top

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.

Body ()

Root Schema : publicSectorConditionOfApprovalTemplates-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "COATemplateItems":{
            "title":"Conditions of Approval Template Items",
            "type":"array",
            "description":"The conditions of approval template item resource is used to create, update, and delete the template items used in the conditions of approval.",
            "items":{
                "$ref":"#/components/schemas/publicSectorConditionOfApprovalTemplates-COATemplateItems-item-response"
            }
        },
        "Description":{
            "maxLength":"1000",
            "type":"string",
            "description":"The description of the template.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the agency.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EnabledFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if the template is enabled.",
            "nullable":false,
            "x-queryable":true
        },
        "TemplateId":{
            "maxLength":"20",
            "type":"string",
            "description":"The unique identifier of the template.",
            "nullable":false,
            "x-queryable":true
        },
        "Name":{
            "maxLength":"50",
            "type":"string",
            "description":"The name of the template.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

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

• Array of: object publicSectorConditionOfApprovalTemplates-COATemplateItems-item-response

{
    "title":"Conditions of Approval Template Items",
    "type":"array",
    "description":"The conditions of approval template item resource is used to create, update, and delete the template items used in the conditions of approval.",
    "items":{
        "$ref":"#/components/schemas/publicSectorConditionOfApprovalTemplates-COATemplateItems-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : publicSectorConditionOfApprovalTemplates-COATemplateItems-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the agency.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "PrintSeq":{
            "type":"integer",
            "description":"Indicates the print sequence of the condition.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"3"
            },
            "x-queryable":true
        },
        "ReorderData":{
            "type":"string",
            "description":"Used to set PrintSeq for conditions. Optionally, accepts data in the given format for PATCH request. \nOPERATION; COAKey1: PrintSeqNum; COAKey2: PrintSeqNum; COAKey3: PrintSeqNum. Currently, OPERATION supports only the value 'REORDER'.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ConditionId":{
            "maxLength":"20",
            "type":"string",
            "description":"The identifier of the condition that is being linked to the template.",
            "nullable":false,
            "x-queryable":true
        },
        "EnabledFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if the template item is enabled.",
            "nullable":false,
            "x-queryable":true
        },
        "TemplateId":{
            "maxLength":"20",
            "type":"string",
            "description":"The unique identifier of the template.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

COATemplateItems

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorConditionOfApprovalTemplates/{publicSectorConditionOfApprovalTemplatesUniqID}/child/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.

Back to Top