Jump to

• Request
• Response

Update a compliance period in the conditions of approval

patch

/fscmRestApi/resources/11.13.18.05/publicSectorConditionsOfApprovalTransactions/{CoaKey}/child/COAConditionComplyPeriods/{COAConditionComplyPeriodsUniqID}

Request

Supported Media Types

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

Path Parameters

• COAConditionComplyPeriodsUniqID: integer
  This is the hash key of the attributes which make up the composite key--- CoaKey and ComplyPrdId ---for the Conditions of Approval Compliance Periods resource and used to uniquely identify an instance of Conditions of Approval Compliance Periods. The client should not generate the hash key value. Instead, the client should query on the Conditions of Approval Compliance Periods collection resource with a filter on the primary key values in order to navigate to a specific instance of Conditions of Approval Compliance Periods.
  
  For example: COAConditionComplyPeriods?q=CoaKey=<value1>;ComplyPrdId=<value2>
• CoaKey: integer
  The unique identifier of the condition of approval.

Body ()

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

Root Schema : publicSectorConditionsOfApprovalTransactions-COAConditionComplyPeriods-item

Type: object

Show Source

• CoaKey(optional): integer(int64)
  The unique identifier of the condition of approval.
• ComplyPrdId(optional): string
  Maximum Length: 20

  The identifier of the compliance period associated with the conditions of approval.
• EnabledFlag(optional): string
  Maximum Length: 1

  Indicates if the compliance period is applicable to the conditions of approval.
• links(optional): array Items
  Title: Items

  Link Relations

{
    "properties":{
        "CoaKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the condition of approval."
        },
        "ComplyPrdId":{
            "maxLength":20,
            "type":"string",
            "description":"The identifier of the compliance period associated with the conditions of approval."
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the compliance period is applicable to the conditions of approval."
        },
        "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 : publicSectorConditionsOfApprovalTransactions-COAConditionComplyPeriods-item

Type: object

Show Source

• CoaKey(optional): integer(int64)
  The unique identifier of the condition of approval.
• ComplyPrdId(optional): string
  Maximum Length: 20

  The identifier of the compliance period associated with the conditions of approval.
• EnabledFlag(optional): string
  Maximum Length: 1

  Indicates if the compliance period is applicable to the conditions of approval.
• links(optional): array Items
  Title: Items

  Link Relations

{
    "properties":{
        "CoaKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the condition of approval."
        },
        "ComplyPrdId":{
            "maxLength":20,
            "type":"string",
            "description":"The identifier of the compliance period associated with the conditions of approval."
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the compliance period is applicable to the conditions of approval."
        },
        "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