Jump to

• Request
• Response

Create a validation group detail

post

/fscmRestApi/resources/11.13.18.05/publicSectorValidationGroupDetails

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 for the agency.
• ApplyValidation: string
  Title: Apply Validation

  Maximum Length: 30

  Indicates whether the validation should be applied to all licenses or any license.
• EnabledFlag: string
  Title: Enabled

  Maximum Length: 1

  Default Value: Y

  Indicates whether the validation criteria are enabled. The default is Y for yes.
• GracePeriod: integer (int64)
  Title: Grace Period

  The grace period duration.
• GracePeriodUom: string
  Title: Grace Period UOM

  Maximum Length: 30

  The unit of time of the grace period duration.
• LicenseMustHave: string
  Title: License Requirements

  Maximum Length: 30

  Indicates whether the contractor license must have all or at least one of the specified values.
• ValidateExpFlag: string
  Title: Expiration Validation

  Maximum Length: 1

  Default Value: N

  Indicates whether the expiration must be validated. The default value is N for no.
• ValidationGroupDetailValues: array Validation Group Detail Values
  Title: Validation Group Detail Values

  The validaton group detail values resource is used to view, add, delete, and modify the validation values for validation options such as insurance.
• ValidationGroupId(required): string
  Title: Group ID

  Maximum Length: 50

  The unique identifier for a validation group.
• ValidationOption(required): string
  Title: Option

  Maximum Length: 30

  Indicates the type of validation, such as the contractor license type or insurance.

{
    "required":[
        "ValidationGroupId",
        "ValidationOption"
    ],
    "type":"object",
    "properties":{
        "ValidationGroupId":{
            "title":"Group ID",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for a validation group.",
            "nullable":false
        },
        "ApplyValidation":{
            "title":"Apply Validation",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the validation should be applied to all licenses or any license.",
            "nullable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier for the agency.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            }
        },
        "LicenseMustHave":{
            "title":"License Requirements",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the contractor license must have all or at least one of the specified values.",
            "nullable":true
        },
        "GracePeriodUom":{
            "title":"Grace Period UOM",
            "maxLength":30,
            "type":"string",
            "description":"The unit of time of the grace period duration.",
            "nullable":true
        },
        "ValidateExpFlag":{
            "title":"Expiration Validation",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the expiration must be validated. The default value is N for no.",
            "nullable":false,
            "default":"N"
        },
        "ValidationGroupDetailValues":{
            "title":"Validation Group Detail Values",
            "type":"array",
            "description":"The validaton group detail values resource is used to view, add, delete, and modify the validation values for validation options such as insurance.",
            "items":{
                "$ref":"#/components/schemas/publicSectorValidationGroupDetails-ValidationGroupDetailValues-item-post-request"
            }
        },
        "ValidationOption":{
            "title":"Option",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the type of validation, such as the contractor license type or insurance.",
            "nullable":false
        },
        "GracePeriod":{
            "title":"Grace Period",
            "type":"integer",
            "description":"The grace period duration.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the validation criteria are enabled. The default is Y for yes.",
            "nullable":false,
            "default":"Y"
        }
    }
}

Nested Schema : Validation Group Detail Values

Type: array

Title: Validation Group Detail Values

The validaton group detail values resource is used to view, add, delete, and modify the validation values for validation options such as insurance.

Show Source

• Array of: object publicSectorValidationGroupDetails-ValidationGroupDetailValues-item-post-request

{
    "title":"Validation Group Detail Values",
    "type":"array",
    "description":"The validaton group detail values resource is used to view, add, delete, and modify the validation values for validation options such as insurance.",
    "items":{
        "$ref":"#/components/schemas/publicSectorValidationGroupDetails-ValidationGroupDetailValues-item-post-request"
    }
}

Nested Schema : publicSectorValidationGroupDetails-ValidationGroupDetailValues-item-post-request

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The unique identifier for the agency using the validation group.
• ApplyValidation: string
  Title: Apply Validation

  Maximum Length: 30

  Indicates whether the validation should be applied to all licenses or any license.
• EnabledFlag: string
  Title: Enabled

  Maximum Length: 1

  Default Value: Y

  Indicates whether the validation criteria are enabled or not. The default value is Y for yes.
• ExpirationBasis: string
  Title: Expiration Basis

  Maximum Length: 30

  The date that is the basis for the expiration rule.
• GracePeriod: integer (int64)
  Title: Grace Period

  The grace period duration.
• GracePeriodUom: string
  Title: Grace Period UOM

  Maximum Length: 30

  The unit of time of the grace period duration.
• ValidateExpFlag: string
  Title: Expiration Validation

  Maximum Length: 1

  Default Value: N

  Indicates whether the expiration must be validated. The default value is N for no.
• ValidationGroupId: string
  Title: Group ID

  Maximum Length: 50

  The unique identifier for a validation group.
• ValidationOption: string
  Title: Option

  Maximum Length: 30

  Indicates the type of validation, such as contractor license type or insurance.
• ValidationValue: string
  Title: Validation Criteria

  Maximum Length: 30

  The contractor license criteria that must be validated.

{
    "type":"object",
    "properties":{
        "ValidationGroupId":{
            "title":"Group ID",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for a validation group.",
            "nullable":false
        },
        "ApplyValidation":{
            "title":"Apply Validation",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the validation should be applied to all licenses or any license.",
            "nullable":true
        },
        "ValidationValue":{
            "title":"Validation Criteria",
            "maxLength":30,
            "type":"string",
            "description":"The contractor license criteria that must be validated.",
            "nullable":false
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier for the agency using the validation group.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            }
        },
        "ExpirationBasis":{
            "title":"Expiration Basis",
            "maxLength":30,
            "type":"string",
            "description":"The date that is the basis for the expiration rule.",
            "nullable":true
        },
        "ValidateExpFlag":{
            "title":"Expiration Validation",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the expiration must be validated. The default value is N for no.",
            "nullable":false,
            "default":"N"
        },
        "GracePeriodUom":{
            "title":"Grace Period UOM",
            "maxLength":30,
            "type":"string",
            "description":"The unit of time of the grace period duration.",
            "nullable":true
        },
        "ValidationOption":{
            "title":"Option",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the type of validation, such as contractor license type or insurance.",
            "nullable":false
        },
        "GracePeriod":{
            "title":"Grace Period",
            "type":"integer",
            "description":"The grace period duration.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the validation criteria are enabled or not. The default value is Y for yes.",
            "nullable":false,
            "default":"Y"
        }
    }
}

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 : publicSectorValidationGroupDetails-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The unique identifier for the agency.
• ApplyValidation: string
  Title: Apply Validation

  Maximum Length: 30

  Indicates whether the validation should be applied to all licenses or any license.
• EnabledFlag: string
  Title: Enabled

  Maximum Length: 1

  Default Value: Y

  Indicates whether the validation criteria are enabled. The default is Y for yes.
• GracePeriod: integer (int64)
  Title: Grace Period

  The grace period duration.
• GracePeriodUom: string
  Title: Grace Period UOM

  Maximum Length: 30

  The unit of time of the grace period duration.
• LastUpdateDate: string (date-time)
  Title: Last Updated

  Read Only: true

  The date and time when the row was last updated.
• LastUpdatedByName: string
  Title: Last Updated By

  Read Only: true

  The user who last updated the row.
• LicenseMustHave: string
  Title: License Requirements

  Maximum Length: 30

  Indicates whether the contractor license must have all or at least one of the specified values.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ValidateExpFlag: string
  Title: Expiration Validation

  Maximum Length: 1

  Default Value: N

  Indicates whether the expiration must be validated. The default value is N for no.
• ValidationGroupDetailValues: array Validation Group Detail Values
  Title: Validation Group Detail Values

  The validaton group detail values resource is used to view, add, delete, and modify the validation values for validation options such as insurance.
• ValidationGroupId: string
  Title: Group ID

  Maximum Length: 50

  The unique identifier for a validation group.
• ValidationOption: string
  Title: Option

  Maximum Length: 30

  Indicates the type of validation, such as the contractor license type or insurance.

{
    "type":"object",
    "properties":{
        "ValidationGroupId":{
            "title":"Group ID",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for a validation group.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier for the agency.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "LicenseMustHave":{
            "title":"License Requirements",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the contractor license must have all or at least one of the specified values.",
            "nullable":true,
            "x-queryable":true
        },
        "ApplyValidation":{
            "title":"Apply Validation",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the validation should be applied to all licenses or any license.",
            "nullable":true,
            "x-queryable":true
        },
        "GracePeriodUom":{
            "title":"Grace Period UOM",
            "maxLength":30,
            "type":"string",
            "description":"The unit of time of the grace period duration.",
            "nullable":true,
            "x-queryable":true
        },
        "ValidateExpFlag":{
            "title":"Expiration Validation",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the expiration must be validated. The default value is N for no.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "ValidationGroupDetailValues":{
            "title":"Validation Group Detail Values",
            "type":"array",
            "description":"The validaton group detail values resource is used to view, add, delete, and modify the validation values for validation options such as insurance.",
            "items":{
                "$ref":"#/components/schemas/publicSectorValidationGroupDetails-ValidationGroupDetailValues-item-response"
            }
        },
        "ValidationOption":{
            "title":"Option",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the type of validation, such as the contractor license type or insurance.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdatedByName":{
            "title":"Last Updated By",
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "GracePeriod":{
            "title":"Grace Period",
            "type":"integer",
            "description":"The grace period duration.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            },
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the validation criteria are enabled. The default is Y for yes.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "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 : Validation Group Detail Values

Type: array

Title: Validation Group Detail Values

The validaton group detail values resource is used to view, add, delete, and modify the validation values for validation options such as insurance.

Show Source

• Array of: object publicSectorValidationGroupDetails-ValidationGroupDetailValues-item-response

{
    "title":"Validation Group Detail Values",
    "type":"array",
    "description":"The validaton group detail values resource is used to view, add, delete, and modify the validation values for validation options such as insurance.",
    "items":{
        "$ref":"#/components/schemas/publicSectorValidationGroupDetails-ValidationGroupDetailValues-item-response"
    }
}

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

Nested Schema : publicSectorValidationGroupDetails-ValidationGroupDetailValues-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The unique identifier for the agency using the validation group.
• ApplyValidation: string
  Title: Apply Validation

  Maximum Length: 30

  Indicates whether the validation should be applied to all licenses or any license.
• EnabledFlag: string
  Title: Enabled

  Maximum Length: 1

  Default Value: Y

  Indicates whether the validation criteria are enabled or not. The default value is Y for yes.
• ExpirationBasis: string
  Title: Expiration Basis

  Maximum Length: 30

  The date that is the basis for the expiration rule.
• GracePeriod: integer (int64)
  Title: Grace Period

  The grace period duration.
• GracePeriodUom: string
  Title: Grace Period UOM

  Maximum Length: 30

  The unit of time of the grace period duration.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ValidateExpFlag: string
  Title: Expiration Validation

  Maximum Length: 1

  Default Value: N

  Indicates whether the expiration must be validated. The default value is N for no.
• ValidationGroupId: string
  Title: Group ID

  Maximum Length: 50

  The unique identifier for a validation group.
• ValidationOption: string
  Title: Option

  Maximum Length: 30

  Indicates the type of validation, such as contractor license type or insurance.
• ValidationValue: string
  Title: Validation Criteria

  Maximum Length: 30

  The contractor license criteria that must be validated.

{
    "type":"object",
    "properties":{
        "ValidationGroupId":{
            "title":"Group ID",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for a validation group.",
            "nullable":false,
            "x-queryable":true
        },
        "ApplyValidation":{
            "title":"Apply Validation",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the validation should be applied to all licenses or any license.",
            "nullable":true,
            "x-queryable":true
        },
        "ValidationValue":{
            "title":"Validation Criteria",
            "maxLength":30,
            "type":"string",
            "description":"The contractor license criteria that must be validated.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier for the agency using the validation group.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "ExpirationBasis":{
            "title":"Expiration Basis",
            "maxLength":30,
            "type":"string",
            "description":"The date that is the basis for the expiration rule.",
            "nullable":true,
            "x-queryable":true
        },
        "ValidateExpFlag":{
            "title":"Expiration Validation",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the expiration must be validated. The default value is N for no.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "GracePeriodUom":{
            "title":"Grace Period UOM",
            "maxLength":30,
            "type":"string",
            "description":"The unit of time of the grace period duration.",
            "nullable":true,
            "x-queryable":true
        },
        "ValidationOption":{
            "title":"Option",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the type of validation, such as contractor license type or insurance.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "GracePeriod":{
            "title":"Grace Period",
            "type":"integer",
            "description":"The grace period duration.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            },
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the validation criteria are enabled or not. The default value is Y for yes.",
            "nullable":false,
            "default":"Y",
            "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"
    }
}

Links

ValidationGroupDetailValues

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorValidationGroupDetails/{publicSectorValidationGroupDetailsUniqID}/child/ValidationGroupDetailValues

Parameters:

• publicSectorValidationGroupDetailsUniqID: $request.path.publicSectorValidationGroupDetailsUniqID

The validaton group detail values resource is used to view, add, delete, and modify the validation values for validation options such as insurance.

Back to Top