Jump to

• Request
• Response

Update a condition of approval

patch

/fscmRestApi/resources/11.13.18.05/publicSectorConditionOfApprovals/{publicSectorConditionOfApprovalsUniqID}

Request

Supported Media Types

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

Path Parameters

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

Body ()

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

Root Schema : publicSectorConditionOfApprovals-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The unique identifier of the agency.
• CategoryId(optional): string
  Title: Category

  Maximum Length: 20

  The identifier of the category.
• CategoryName(optional): string
  Maximum Length: 50

  The name of the category.
• COAConditionCompliance(optional): 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(optional): string
  Maximum Length: 4000

  The compliances associated with the conditions of approval.
• Condition(optional): string
  Title: Conditions of Approval

  The actual text of the conditions of approval.
• ConditionId(optional): string
  Title: Conditions of Approval ID

  Maximum Length: 20

  The unique identifier of the condition of approval.
• ConditionPlain(optional): string
  Title: Conditions of Approval

  The text of the conditions of approval without any HTML tags.
• ConditionType(optional): string
  Title: Type

  Maximum Length: 12

  The identifier of the condition type.
• EnabledFlag(optional): string
  Title: Enabled

  Maximum Length: 1

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

  Link Relations
• SubcategoryId(optional): string
  Title: Subcategory

  Maximum Length: 20

  The identifier of the subcategory.
• SubcategoryName(optional): string
  Maximum Length: 50

  The name of the subcategory.
• Type(optional): string
  Maximum Length: 80

  The name of the condition type.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency.",
            "title":"Agency ID"
        },
        "COAConditionCompliance":{
            "items":{
                "$ref":"#/definitions/publicSectorConditionOfApprovals-COAConditionCompliance-item"
            },
            "type":"array",
            "description":"The conditions od approval compliance resource is used to create, update, and delete the compliances associated with the conditions of approval.",
            "title":"Conditions of Approval Compliances"
        },
        "CategoryId":{
            "maxLength":20,
            "type":"string",
            "description":"The identifier of the category.",
            "title":"Category"
        },
        "CategoryName":{
            "maxLength":50,
            "type":"string",
            "description":"The name of the category."
        },
        "Compliance":{
            "maxLength":4000,
            "type":"string",
            "description":"The compliances associated with the conditions of approval."
        },
        "Condition":{
            "type":"string",
            "description":"The actual text of the conditions of approval.",
            "title":"Conditions of Approval"
        },
        "ConditionId":{
            "maxLength":20,
            "type":"string",
            "description":"The unique identifier of the condition of approval.",
            "title":"Conditions of Approval ID"
        },
        "ConditionPlain":{
            "type":"string",
            "description":"The text of the conditions of approval without any HTML tags.",
            "title":"Conditions of Approval"
        },
        "ConditionType":{
            "maxLength":12,
            "type":"string",
            "description":"The identifier of the condition type.",
            "title":"Type"
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the condition is enabled.",
            "title":"Enabled"
        },
        "SubcategoryId":{
            "maxLength":20,
            "type":"string",
            "description":"The identifier of the subcategory.",
            "title":"Subcategory"
        },
        "SubcategoryName":{
            "maxLength":50,
            "type":"string",
            "description":"The name of the subcategory."
        },
        "Type":{
            "maxLength":80,
            "type":"string",
            "description":"The name of the condition type."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

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

• Array of: object publicSectorConditionOfApprovals-COAConditionCompliance-item

{
    "items":{
        "$ref":"#/definitions/publicSectorConditionOfApprovals-COAConditionCompliance-item"
    },
    "type":"array",
    "description":"The conditions od approval compliance resource is used to create, update, and delete the compliances associated with the conditions of approval.",
    "title":"Conditions of Approval Compliances"
}

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 : publicSectorConditionOfApprovals-COAConditionCompliance-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The unique identifier of the agency.
• ComplyPrdId(optional): string
  Title: Compliance Period

  Maximum Length: 12

  The identifier of the compliances associated with the conditions of approval.
• ConditionId(optional): string
  Title: Conditions of Approval ID

  Maximum Length: 20

  The unique identifier of the condition of approval.
• EnabledFlag(optional): boolean
  Title: Enabled

  The identifier to indicate if the compliance is enabled.
• links(optional): array Items
  Title: Items

  Link Relations

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency.",
            "title":"Agency ID"
        },
        "ComplyPrdId":{
            "maxLength":12,
            "type":"string",
            "description":"The identifier of the compliances associated with the conditions of approval.",
            "title":"Compliance Period"
        },
        "ConditionId":{
            "maxLength":20,
            "type":"string",
            "description":"The unique identifier of the condition of approval.",
            "title":"Conditions of Approval ID"
        },
        "EnabledFlag":{
            "type":"boolean",
            "description":"The identifier to indicate if the compliance is enabled.",
            "title":"Enabled"
        },
        "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 : publicSectorConditionOfApprovals-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The unique identifier of the agency.
• CategoryId(optional): string
  Title: Category

  Maximum Length: 20

  The identifier of the category.
• CategoryName(optional): string
  Maximum Length: 50

  The name of the category.
• COAConditionCompliance(optional): 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(optional): string
  Maximum Length: 4000

  The compliances associated with the conditions of approval.
• Condition(optional): string
  Title: Conditions of Approval

  The actual text of the conditions of approval.
• ConditionId(optional): string
  Title: Conditions of Approval ID

  Maximum Length: 20

  The unique identifier of the condition of approval.
• ConditionPlain(optional): string
  Title: Conditions of Approval

  The text of the conditions of approval without any HTML tags.
• ConditionType(optional): string
  Title: Type

  Maximum Length: 12

  The identifier of the condition type.
• EnabledFlag(optional): string
  Title: Enabled

  Maximum Length: 1

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

  Link Relations
• SubcategoryId(optional): string
  Title: Subcategory

  Maximum Length: 20

  The identifier of the subcategory.
• SubcategoryName(optional): string
  Maximum Length: 50

  The name of the subcategory.
• Type(optional): string
  Maximum Length: 80

  The name of the condition type.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency.",
            "title":"Agency ID"
        },
        "COAConditionCompliance":{
            "items":{
                "$ref":"#/definitions/publicSectorConditionOfApprovals-COAConditionCompliance-item"
            },
            "type":"array",
            "description":"The conditions od approval compliance resource is used to create, update, and delete the compliances associated with the conditions of approval.",
            "title":"Conditions of Approval Compliances"
        },
        "CategoryId":{
            "maxLength":20,
            "type":"string",
            "description":"The identifier of the category.",
            "title":"Category"
        },
        "CategoryName":{
            "maxLength":50,
            "type":"string",
            "description":"The name of the category."
        },
        "Compliance":{
            "maxLength":4000,
            "type":"string",
            "description":"The compliances associated with the conditions of approval."
        },
        "Condition":{
            "type":"string",
            "description":"The actual text of the conditions of approval.",
            "title":"Conditions of Approval"
        },
        "ConditionId":{
            "maxLength":20,
            "type":"string",
            "description":"The unique identifier of the condition of approval.",
            "title":"Conditions of Approval ID"
        },
        "ConditionPlain":{
            "type":"string",
            "description":"The text of the conditions of approval without any HTML tags.",
            "title":"Conditions of Approval"
        },
        "ConditionType":{
            "maxLength":12,
            "type":"string",
            "description":"The identifier of the condition type.",
            "title":"Type"
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the condition is enabled.",
            "title":"Enabled"
        },
        "SubcategoryId":{
            "maxLength":20,
            "type":"string",
            "description":"The identifier of the subcategory.",
            "title":"Subcategory"
        },
        "SubcategoryName":{
            "maxLength":50,
            "type":"string",
            "description":"The name of the subcategory."
        },
        "Type":{
            "maxLength":80,
            "type":"string",
            "description":"The name of the condition type."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

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

• Array of: object publicSectorConditionOfApprovals-COAConditionCompliance-item

{
    "items":{
        "$ref":"#/definitions/publicSectorConditionOfApprovals-COAConditionCompliance-item"
    },
    "type":"array",
    "description":"The conditions od approval compliance resource is used to create, update, and delete the compliances associated with the conditions of approval.",
    "title":"Conditions of Approval Compliances"
}

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 : publicSectorConditionOfApprovals-COAConditionCompliance-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The unique identifier of the agency.
• ComplyPrdId(optional): string
  Title: Compliance Period

  Maximum Length: 12

  The identifier of the compliances associated with the conditions of approval.
• ConditionId(optional): string
  Title: Conditions of Approval ID

  Maximum Length: 20

  The unique identifier of the condition of approval.
• EnabledFlag(optional): boolean
  Title: Enabled

  The identifier to indicate if the compliance is enabled.
• links(optional): array Items
  Title: Items

  Link Relations

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency.",
            "title":"Agency ID"
        },
        "ComplyPrdId":{
            "maxLength":12,
            "type":"string",
            "description":"The identifier of the compliances associated with the conditions of approval.",
            "title":"Compliance Period"
        },
        "ConditionId":{
            "maxLength":20,
            "type":"string",
            "description":"The unique identifier of the condition of approval.",
            "title":"Conditions of Approval ID"
        },
        "EnabledFlag":{
            "type":"boolean",
            "description":"The identifier to indicate if the compliance is enabled.",
            "title":"Enabled"
        },
        "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