Jump to

• Request
• Response

Create a set of conditions of approval

post

/fscmRestApi/resources/11.13.18.05/publicSectorConditionOfApprovals

Request

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.
• Upsert-Mode:
  When set to true, the server will perform an Upsert operation instead of a Create. In an Upsert operation the server attempts to find an existing resource that matches the payload. If found, the server updates the existing resource instead of creating a new one. If not found, or when set to false (the default), a Create is performed.

Supported Media Types

• application/json

Request Body - application/json ()

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

Root Schema : schema

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

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

  Maximum Length: 20

  The identifier of the category.
• COAConditionCompliance: 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.
• Condition: string (byte)
  Title: Conditions of Approval

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

  Maximum Length: 20

  The unique identifier of the condition of approval.
• ConditionType(required): string
  Title: Type

  Maximum Length: 12

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

  Maximum Length: 1

  Default Value: false

  Indicates if the condition is enabled.
• SubcategoryId: string
  Title: Subcategory

  Maximum Length: 20

  The identifier of the subcategory.

{
    "required":[
        "ConditionId",
        "ConditionType"
    ],
    "type":"object",
    "properties":{
        "CategoryId":{
            "title":"Category",
            "maxLength":20,
            "type":"string",
            "description":"The identifier of the category.",
            "nullable":true
        },
        "Condition":{
            "title":"Conditions of Approval",
            "type":"string",
            "description":"The actual text of the conditions of approval.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "COAConditionCompliance":{
            "title":"Conditions of Approval Compliances",
            "type":"array",
            "description":"The conditions od approval compliance resource is used to create, update, and delete the compliances associated with the conditions of approval.",
            "items":{
                "$ref":"#/components/schemas/publicSectorConditionOfApprovals-COAConditionCompliance-item-post-request"
            }
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of the agency.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            }
        },
        "SubcategoryId":{
            "title":"Subcategory",
            "maxLength":20,
            "type":"string",
            "description":"The identifier of the subcategory.",
            "nullable":true
        },
        "ConditionId":{
            "title":"Conditions of Approval ID",
            "maxLength":20,
            "type":"string",
            "description":"The unique identifier of the condition of approval.",
            "nullable":false
        },
        "ConditionType":{
            "title":"Type",
            "maxLength":12,
            "type":"string",
            "description":"The identifier of the condition type.",
            "nullable":false
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the condition is enabled.",
            "nullable":false,
            "default":false
        }
    }
}

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 schema

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

Nested Schema : schema

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.

{
    "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
        },
        "ConditionId":{
            "title":"Conditions of Approval ID",
            "maxLength":20,
            "type":"string",
            "description":"The unique identifier of the condition of approval.",
            "nullable":false
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of the agency.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            }
        },
        "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-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

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

  Maximum Length: 20

  The identifier of the category.
• CategoryName: string
  Read Only: true

  Maximum Length: 50

  The name of the category.
• COAConditionCompliance: 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: string
  Read Only: true

  Maximum Length: 4000

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

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

  Maximum Length: 20

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

  Read Only: true

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

  Maximum Length: 12

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

  Maximum Length: 1

  Default Value: false

  Indicates if the condition is enabled.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SubcategoryId: string
  Title: Subcategory

  Maximum Length: 20

  The identifier of the subcategory.
• SubcategoryName: string
  Read Only: true

  Maximum Length: 50

  The name of the subcategory.
• Type: string
  Read Only: true

  Maximum Length: 80

  The name of the condition type.

{
    "type":"object",
    "properties":{
        "CategoryId":{
            "title":"Category",
            "maxLength":20,
            "type":"string",
            "description":"The identifier of the category.",
            "nullable":true,
            "x-queryable":true
        },
        "Condition":{
            "title":"Conditions of Approval",
            "type":"string",
            "description":"The actual text of the conditions of approval.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "COAConditionCompliance":{
            "title":"Conditions of Approval Compliances",
            "type":"array",
            "description":"The conditions od approval compliance resource is used to create, update, and delete the compliances associated with the conditions of approval.",
            "items":{
                "$ref":"#/components/schemas/publicSectorConditionOfApprovals-COAConditionCompliance-item-response"
            }
        },
        "Compliance":{
            "maxLength":4000,
            "type":"string",
            "description":"The compliances associated with the conditions of approval.",
            "nullable":true,
            "readOnly":true,
            "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
        },
        "SubcategoryId":{
            "title":"Subcategory",
            "maxLength":20,
            "type":"string",
            "description":"The identifier of the subcategory.",
            "nullable":true,
            "x-queryable":true
        },
        "SubcategoryName":{
            "maxLength":50,
            "type":"string",
            "description":"The name of the subcategory.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConditionPlain":{
            "title":"Conditions of Approval",
            "type":"string",
            "description":"The text of the conditions of approval without any HTML tags.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Type":{
            "maxLength":80,
            "type":"string",
            "description":"The name of the condition type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryName":{
            "maxLength":50,
            "type":"string",
            "description":"The name of the category.",
            "nullable":true,
            "readOnly":true,
            "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
        },
        "ConditionType":{
            "title":"Type",
            "maxLength":12,
            "type":"string",
            "description":"The identifier of the condition type.",
            "nullable":false,
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the condition is enabled.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        }
    }
}

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-response

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

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 : 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."
        }
    }
}

Links

COAConditionCompliance

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorConditionOfApprovals/{publicSectorConditionOfApprovalsUniqID}/child/COAConditionCompliance

Parameters:

• publicSectorConditionOfApprovalsUniqID: $request.path.publicSectorConditionOfApprovalsUniqID

The conditions od approval compliance resource is used to create, update, and delete the compliances associated with the conditions of approval.

Back to Top