Jump to

• Request
• Response

Update a condition of approval compliance

patch

/fscmRestApi/resources/11.13.18.05/publicSectorConditionOfApprovals/{publicSectorConditionOfApprovalsUniqID}/child/COAConditionCompliance/{COAConditionComplianceUniqID}

Request

Path Parameters

• COAConditionComplianceUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- AgencyId, ConditionId and ComplyPrdId ---for the Conditions of Approval Compliances resource and used to uniquely identify an instance of Conditions of Approval Compliances. The client should not generate the hash key value. Instead, the client should query on the Conditions of Approval Compliances collection resource with a filter on the primary key values in order to navigate to a specific instance of Conditions of Approval Compliances.
  
  For example: COAConditionCompliance?q=AgencyId=<value1>;ConditionId=<value2>;ComplyPrdId=<value3>
• publicSectorConditionOfApprovalsUniqID(required): string
  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>

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

• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Default Value: false

  The identifier to indicate if the compliance is enabled.

{
    "type":"object",
    "properties":{
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"The identifier to indicate if the compliance is enabled.",
            "nullable":false,
            "default":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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 : publicSectorConditionOfApprovals-COAConditionCompliance-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

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

  Maximum Length: 12

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

  Maximum Length: 20

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

  Maximum Length: 1

  Default Value: false

  The identifier to indicate if the compliance is enabled.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "ComplyPrdId":{
            "title":"Compliance Period",
            "maxLength":12,
            "type":"string",
            "description":"The identifier of the compliances associated with the conditions of approval.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ConditionId":{
            "title":"Conditions of Approval ID",
            "maxLength":20,
            "type":"string",
            "description":"The unique identifier of the condition of approval.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of the agency.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"The identifier to indicate if the compliance is enabled.",
            "nullable":false,
            "default":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."
        }
    }
}

Back to Top