Jump to

• Request
• Response

Update a conditions of approval template

patch

/fscmRestApi/resources/11.13.18.05/publicSectorConditionOfApprovalTemplates/{publicSectorConditionOfApprovalTemplatesUniqID}

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Path Parameters

• publicSectorConditionOfApprovalTemplatesUniqID: integer
  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>

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorConditionOfApprovalTemplates-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  The unique identifier of the agency.
• COATemplateItems(optional): 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(optional): string
  Maximum Length: 1000

  The description of the template.
• EnabledFlag(optional): string
  Maximum Length: 1

  Indicates if the template is enabled.
• links(optional): array Items
  Title: Items

  Link Relations
• Name(optional): string
  Maximum Length: 50

  The name of the template.
• TemplateId(optional): string
  Maximum Length: 20

  The unique identifier of the template.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency."
        },
        "COATemplateItems":{
            "items":{
                "$ref":"#/definitions/publicSectorConditionOfApprovalTemplates-COATemplateItems-item"
            },
            "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.",
            "title":"Conditions of Approval Template Items"
        },
        "Description":{
            "maxLength":1000,
            "type":"string",
            "description":"The description of the template."
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the template is enabled."
        },
        "Name":{
            "maxLength":50,
            "type":"string",
            "description":"The name of the template."
        },
        "TemplateId":{
            "maxLength":20,
            "type":"string",
            "description":"The unique identifier of the template."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

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

{
    "items":{
        "$ref":"#/definitions/publicSectorConditionOfApprovalTemplates-COATemplateItems-item"
    },
    "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.",
    "title":"Conditions of Approval Template Items"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : publicSectorConditionOfApprovalTemplates-COATemplateItems-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  The unique identifier of the agency.
• ConditionId(optional): string
  Maximum Length: 20

  The identifier of the condition that is being linked to the template.
• EnabledFlag(optional): string
  Maximum Length: 1

  Indicates if the template item is enabled.
• links(optional): array Items
  Title: Items

  Link Relations
• TemplateId(optional): string
  Maximum Length: 20

  The unique identifier of the template.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency."
        },
        "ConditionId":{
            "maxLength":20,
            "type":"string",
            "description":"The identifier of the condition that is being linked to the template."
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the template item is enabled."
        },
        "TemplateId":{
            "maxLength":20,
            "type":"string",
            "description":"The unique identifier of the template."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorConditionOfApprovalTemplates-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  The unique identifier of the agency.
• COATemplateItems(optional): 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(optional): string
  Maximum Length: 1000

  The description of the template.
• EnabledFlag(optional): string
  Maximum Length: 1

  Indicates if the template is enabled.
• links(optional): array Items
  Title: Items

  Link Relations
• Name(optional): string
  Maximum Length: 50

  The name of the template.
• TemplateId(optional): string
  Maximum Length: 20

  The unique identifier of the template.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency."
        },
        "COATemplateItems":{
            "items":{
                "$ref":"#/definitions/publicSectorConditionOfApprovalTemplates-COATemplateItems-item"
            },
            "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.",
            "title":"Conditions of Approval Template Items"
        },
        "Description":{
            "maxLength":1000,
            "type":"string",
            "description":"The description of the template."
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the template is enabled."
        },
        "Name":{
            "maxLength":50,
            "type":"string",
            "description":"The name of the template."
        },
        "TemplateId":{
            "maxLength":20,
            "type":"string",
            "description":"The unique identifier of the template."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

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

{
    "items":{
        "$ref":"#/definitions/publicSectorConditionOfApprovalTemplates-COATemplateItems-item"
    },
    "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.",
    "title":"Conditions of Approval Template Items"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : publicSectorConditionOfApprovalTemplates-COATemplateItems-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  The unique identifier of the agency.
• ConditionId(optional): string
  Maximum Length: 20

  The identifier of the condition that is being linked to the template.
• EnabledFlag(optional): string
  Maximum Length: 1

  Indicates if the template item is enabled.
• links(optional): array Items
  Title: Items

  Link Relations
• TemplateId(optional): string
  Maximum Length: 20

  The unique identifier of the template.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency."
        },
        "ConditionId":{
            "maxLength":20,
            "type":"string",
            "description":"The identifier of the condition that is being linked to the template."
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the template item is enabled."
        },
        "TemplateId":{
            "maxLength":20,
            "type":"string",
            "description":"The unique identifier of the template."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top