Jump to

• Request
• Response

Update a conditions of approval category

patch

/fscmRestApi/resources/11.13.18.05/publicSectorConditionsOfApprovalCategories/{publicSectorConditionsOfApprovalCategoriesUniqID}

Request

Supported Media Types

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

Path Parameters

• publicSectorConditionsOfApprovalCategoriesUniqID: integer
  This is the hash key of the attributes which make up the composite key--- AgencyId and CategoryId ---for the Conditions of Approval Categories resource and used to uniquely identify an instance of Conditions of Approval Categories. The client should not generate the hash key value. Instead, the client should query on the Conditions of Approval Categories collection resource with a filter on the primary key values in order to navigate to a specific instance of Conditions of Approval Categories.
  
  For example: publicSectorConditionsOfApprovalCategories?q=AgencyId=<value1>;CategoryId=<value2>

Body ()

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

Root Schema : publicSectorConditionsOfApprovalCategories-item

Type: object

Show Source

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

  The unique identifier of the category.
• COASubcategorySetup(optional): array Conditions of Approval Subcategories
  Title: Conditions of Approval Subcategories

  The conditions of approval subcategory resource is used to create, update, and delete the subcategories of the conditions of approval.
• Description(optional): string
  Maximum Length: 1000

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

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

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

  The name of the category.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency."
        },
        "COASubcategorySetup":{
            "items":{
                "$ref":"#/definitions/publicSectorConditionsOfApprovalCategories-COASubcategorySetup-item"
            },
            "type":"array",
            "description":"The conditions of approval subcategory resource is used to create, update, and delete the subcategories of the conditions of approval.",
            "title":"Conditions of Approval Subcategories"
        },
        "CategoryId":{
            "maxLength":20,
            "type":"string",
            "description":"The unique identifier of the category."
        },
        "Description":{
            "maxLength":1000,
            "type":"string",
            "description":"The description of the category."
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the category is enabled."
        },
        "Name":{
            "maxLength":50,
            "type":"string",
            "description":"The name of the category."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Conditions of Approval Subcategories

Type: array

Title: Conditions of Approval Subcategories

The conditions of approval subcategory resource is used to create, update, and delete the subcategories of the conditions of approval.

Show Source

• Array of: object publicSectorConditionsOfApprovalCategories-COASubcategorySetup-item

{
    "items":{
        "$ref":"#/definitions/publicSectorConditionsOfApprovalCategories-COASubcategorySetup-item"
    },
    "type":"array",
    "description":"The conditions of approval subcategory resource is used to create, update, and delete the subcategories of the conditions of approval.",
    "title":"Conditions of Approval Subcategories"
}

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 : publicSectorConditionsOfApprovalCategories-COASubcategorySetup-item

Type: object

Show Source

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

  The unique identifier of the category.
• Description(optional): string
  Maximum Length: 1000

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

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

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

  The name of the subcategory.
• SubcategoryId(optional): string
  Maximum Length: 20

  The unique identifier of the subcategory.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency."
        },
        "CategoryId":{
            "maxLength":20,
            "type":"string",
            "description":"The unique identifier of the category."
        },
        "Description":{
            "maxLength":1000,
            "type":"string",
            "description":"The description of the subcategory."
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the subcategory is enabled."
        },
        "Name":{
            "maxLength":50,
            "type":"string",
            "description":"The name of the subcategory."
        },
        "SubcategoryId":{
            "maxLength":20,
            "type":"string",
            "description":"The unique identifier of the subcategory."
        },
        "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 : publicSectorConditionsOfApprovalCategories-item

Type: object

Show Source

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

  The unique identifier of the category.
• COASubcategorySetup(optional): array Conditions of Approval Subcategories
  Title: Conditions of Approval Subcategories

  The conditions of approval subcategory resource is used to create, update, and delete the subcategories of the conditions of approval.
• Description(optional): string
  Maximum Length: 1000

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

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

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

  The name of the category.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency."
        },
        "COASubcategorySetup":{
            "items":{
                "$ref":"#/definitions/publicSectorConditionsOfApprovalCategories-COASubcategorySetup-item"
            },
            "type":"array",
            "description":"The conditions of approval subcategory resource is used to create, update, and delete the subcategories of the conditions of approval.",
            "title":"Conditions of Approval Subcategories"
        },
        "CategoryId":{
            "maxLength":20,
            "type":"string",
            "description":"The unique identifier of the category."
        },
        "Description":{
            "maxLength":1000,
            "type":"string",
            "description":"The description of the category."
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the category is enabled."
        },
        "Name":{
            "maxLength":50,
            "type":"string",
            "description":"The name of the category."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Conditions of Approval Subcategories

Type: array

Title: Conditions of Approval Subcategories

The conditions of approval subcategory resource is used to create, update, and delete the subcategories of the conditions of approval.

Show Source

• Array of: object publicSectorConditionsOfApprovalCategories-COASubcategorySetup-item

{
    "items":{
        "$ref":"#/definitions/publicSectorConditionsOfApprovalCategories-COASubcategorySetup-item"
    },
    "type":"array",
    "description":"The conditions of approval subcategory resource is used to create, update, and delete the subcategories of the conditions of approval.",
    "title":"Conditions of Approval Subcategories"
}

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 : publicSectorConditionsOfApprovalCategories-COASubcategorySetup-item

Type: object

Show Source

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

  The unique identifier of the category.
• Description(optional): string
  Maximum Length: 1000

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

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

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

  The name of the subcategory.
• SubcategoryId(optional): string
  Maximum Length: 20

  The unique identifier of the subcategory.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency."
        },
        "CategoryId":{
            "maxLength":20,
            "type":"string",
            "description":"The unique identifier of the category."
        },
        "Description":{
            "maxLength":1000,
            "type":"string",
            "description":"The description of the subcategory."
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the subcategory is enabled."
        },
        "Name":{
            "maxLength":50,
            "type":"string",
            "description":"The name of the subcategory."
        },
        "SubcategoryId":{
            "maxLength":20,
            "type":"string",
            "description":"The unique identifier of the subcategory."
        },
        "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