Jump to

• Request
• Response

Create a validation group details value set

post

/fscmRestApi/resources/11.13.18.05/publicSectorValidationGroups/{publicSectorValidationGroupsUniqID}/child/ValidationGroupDetails/{ValidationGroupDetailsUniqID}/child/ValidationGroupDetailValueSets

Request

Path Parameters

• ValidationGroupDetailsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- ValidationGroupId, ValidationOption and AgencyId ---for the Validation Group Details resource and used to uniquely identify an instance of Validation Group Details. The client should not generate the hash key value. Instead, the client should query on the Validation Group Details collection resource with a filter on the primary key values in order to navigate to a specific instance of Validation Group Details.
  
  For example: ValidationGroupDetails?q=ValidationGroupId=<value1>;ValidationOption=<value2>;AgencyId=<value3>
• publicSectorValidationGroupsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- ValidationGroupId and AgencyId ---for the Validation Groups resource and used to uniquely identify an instance of Validation Groups. The client should not generate the hash key value. Instead, the client should query on the Validation Groups collection resource with a filter on the primary key values in order to navigate to a specific instance of Validation Groups.
  
  For example: publicSectorValidationGroups?q=ValidationGroupId=<value1>;AgencyId=<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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AgencyId: integer (int32)
  Default Value: 1

  Used to indicate agency ID.
• CurrencyCode: string
  Maximum Length: 3

  The currency used for the job cost.
• EnabledFlag: string
  Maximum Length: 1

  Default Value: N

  Indicates whether the configuration row is enabled. Valid values are "Y" and "N".
• ExpirationBasis: string
  Title: Expiration Basis

  Maximum Length: 30

  The date that is the basis for the insurance expiration rule. Valid values are ORA_EFFECTIVE_DATE for effective date, ORA_EXPIRATION_DATE for expiration date.
• GracePeriod: integer (int64)
  Title: Grace Period

  The number that indicates the grace period duration.
• GracePeriodUom: string
  Title: Grace Period UOM

  Maximum Length: 30

  The grace period duration unit of measure. Valid values are ORA_DAYS for day, ORA_WEEKS for weeks , ORA_MONTHS for month, ORA_YEARS for years.
• JobCostOne: number
  Title: Job Cost One

  The job cost or minimum value for a job cost range.
• JobCostTwo: number
  Title: Job Cost Two

  The maximum value for a job cost range.
• ValidateExpFlag: string
  Title: Expiration Validation

  Maximum Length: 1

  Default Value: N

  Indicates whether the insurance expiration must be validated. Valid values are "Y" and "N".
• ValidationDetType: string
  Maximum Length: 30

  The type of validation. It can be job cost or insurance.
• ValidationDetValue: string
  Maximum Length: 30

  The job cost type value or insurance type value. Valid values are ORA_BETWEEN, ORA_NOT_BETWEEN, ORA_LESS_THAN, ORA_LESS_THAN_EQUAL_TO, ORA_MORE_THAN, ORA_MORE_THAN_EQUAL_TO, ORA_NOT_APPLICABLE, ORA_NO_LIMIT.
• ValidationGroupId: string
  Maximum Length: 50

  A unique name that identifies a validation group.
• ValidationOption: string
  Maximum Length: 30

  Indicates the type of validation such as contractor license type or insurance. Valid values are ORA_CNT_INSURANCE, ORA_CNT_CLASSIFICATION, ORA_CNT_LICENSE_TYPE, ORA_CNT_EXPIRATION.
• ValidationValue: string
  Maximum Length: 30

  Indicates the contractor license criteria that must be validated. Valid value are license classification value or license type value or ORA_ALL.

{
    "type":"object",
    "properties":{
        "ValidationGroupId":{
            "maxLength":"50",
            "type":"string",
            "description":"A unique name that identifies a validation group.",
            "nullable":false
        },
        "ValidationDetType":{
            "maxLength":"30",
            "type":"string",
            "description":"The type of validation. It can be job cost or insurance.",
            "nullable":false
        },
        "AgencyId":{
            "type":"integer",
            "description":"Used to indicate agency ID.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            }
        },
        "ValidationValue":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the contractor license criteria that must be validated. Valid value are license classification value or license type value or ORA_ALL.",
            "nullable":false
        },
        "ExpirationBasis":{
            "title":"Expiration Basis",
            "maxLength":"30",
            "type":"string",
            "description":"The date that is the basis for the insurance expiration rule. Valid values are ORA_EFFECTIVE_DATE for effective date,\nORA_EXPIRATION_DATE for expiration date.",
            "nullable":true
        },
        "ValidationDetValue":{
            "maxLength":"30",
            "type":"string",
            "description":"The job cost type value or insurance type value. Valid values are ORA_BETWEEN,\nORA_NOT_BETWEEN,\nORA_LESS_THAN,\nORA_LESS_THAN_EQUAL_TO,\nORA_MORE_THAN,\nORA_MORE_THAN_EQUAL_TO,\nORA_NOT_APPLICABLE,\nORA_NO_LIMIT.",
            "nullable":false
        },
        "CurrencyCode":{
            "maxLength":"3",
            "type":"string",
            "description":"The currency used for the job cost.",
            "nullable":true
        },
        "JobCostTwo":{
            "title":"Job Cost Two",
            "type":"number",
            "description":"The maximum value for a job cost range.",
            "nullable":true
        },
        "JobCostOne":{
            "title":"Job Cost One",
            "type":"number",
            "description":"The job cost or minimum value for a job cost range.",
            "nullable":true
        },
        "GracePeriodUom":{
            "title":"Grace Period UOM",
            "maxLength":"30",
            "type":"string",
            "description":"The grace period duration unit of measure. Valid values are ORA_DAYS  for day, ORA_WEEKS for weeks  , ORA_MONTHS for month, ORA_YEARS for years.",
            "nullable":true
        },
        "ValidateExpFlag":{
            "title":"Expiration Validation",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the insurance expiration must be validated. Valid values are \"Y\" and \"N\".",
            "nullable":false,
            "default":"N"
        },
        "ValidationOption":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the type of validation such as contractor license type or insurance. Valid values are ORA_CNT_INSURANCE, ORA_CNT_CLASSIFICATION, ORA_CNT_LICENSE_TYPE, ORA_CNT_EXPIRATION.",
            "nullable":false
        },
        "GracePeriod":{
            "title":"Grace Period",
            "type":"integer",
            "description":"The number that indicates the grace period duration.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"10"
            }
        },
        "EnabledFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the configuration row is enabled. Valid values are \"Y\" and \"N\".",
            "nullable":false,
            "default":"N"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : publicSectorValidationGroups-ValidationGroupDetails-ValidationGroupDetailValueSets-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Default Value: 1

  Used to indicate agency ID.
• CurrencyCode: string
  Maximum Length: 3

  The currency used for the job cost.
• EnabledFlag: string
  Maximum Length: 1

  Default Value: N

  Indicates whether the configuration row is enabled. Valid values are "Y" and "N".
• ExpirationBasis: string
  Title: Expiration Basis

  Maximum Length: 30

  The date that is the basis for the insurance expiration rule. Valid values are ORA_EFFECTIVE_DATE for effective date, ORA_EXPIRATION_DATE for expiration date.
• GracePeriod: integer (int64)
  Title: Grace Period

  The number that indicates the grace period duration.
• GracePeriodUom: string
  Title: Grace Period UOM

  Maximum Length: 30

  The grace period duration unit of measure. Valid values are ORA_DAYS for day, ORA_WEEKS for weeks , ORA_MONTHS for month, ORA_YEARS for years.
• JobCostOne: number
  Title: Job Cost One

  The job cost or minimum value for a job cost range.
• JobCostTwo: number
  Title: Job Cost Two

  The maximum value for a job cost range.
• 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 insurance expiration must be validated. Valid values are "Y" and "N".
• ValidationDetType: string
  Maximum Length: 30

  The type of validation. It can be job cost or insurance.
• ValidationDetValue: string
  Maximum Length: 30

  The job cost type value or insurance type value. Valid values are ORA_BETWEEN, ORA_NOT_BETWEEN, ORA_LESS_THAN, ORA_LESS_THAN_EQUAL_TO, ORA_MORE_THAN, ORA_MORE_THAN_EQUAL_TO, ORA_NOT_APPLICABLE, ORA_NO_LIMIT.
• ValidationGroupId: string
  Maximum Length: 50

  A unique name that identifies a validation group.
• ValidationOption: string
  Maximum Length: 30

  Indicates the type of validation such as contractor license type or insurance. Valid values are ORA_CNT_INSURANCE, ORA_CNT_CLASSIFICATION, ORA_CNT_LICENSE_TYPE, ORA_CNT_EXPIRATION.
• ValidationValue: string
  Maximum Length: 30

  Indicates the contractor license criteria that must be validated. Valid value are license classification value or license type value or ORA_ALL.

{
    "type":"object",
    "properties":{
        "ValidationGroupId":{
            "maxLength":"50",
            "type":"string",
            "description":"A unique name that identifies a validation group.",
            "nullable":false,
            "x-queryable":true
        },
        "ValidationDetType":{
            "maxLength":"30",
            "type":"string",
            "description":"The type of validation. It can be job cost or insurance.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"Used to indicate agency ID.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "ValidationValue":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the contractor license criteria that must be validated. Valid value are license classification value or license type value or ORA_ALL.",
            "nullable":false,
            "x-queryable":true
        },
        "ExpirationBasis":{
            "title":"Expiration Basis",
            "maxLength":"30",
            "type":"string",
            "description":"The date that is the basis for the insurance expiration rule. Valid values are ORA_EFFECTIVE_DATE for effective date,\nORA_EXPIRATION_DATE for expiration date.",
            "nullable":true,
            "x-queryable":true
        },
        "ValidationDetValue":{
            "maxLength":"30",
            "type":"string",
            "description":"The job cost type value or insurance type value. Valid values are ORA_BETWEEN,\nORA_NOT_BETWEEN,\nORA_LESS_THAN,\nORA_LESS_THAN_EQUAL_TO,\nORA_MORE_THAN,\nORA_MORE_THAN_EQUAL_TO,\nORA_NOT_APPLICABLE,\nORA_NO_LIMIT.",
            "nullable":false,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":"3",
            "type":"string",
            "description":"The currency used for the job cost.",
            "nullable":true,
            "x-queryable":true
        },
        "JobCostTwo":{
            "title":"Job Cost Two",
            "type":"number",
            "description":"The maximum value for a job cost range.",
            "nullable":true,
            "x-queryable":true
        },
        "JobCostOne":{
            "title":"Job Cost One",
            "type":"number",
            "description":"The job cost or minimum value for a job cost range.",
            "nullable":true,
            "x-queryable":true
        },
        "GracePeriodUom":{
            "title":"Grace Period UOM",
            "maxLength":"30",
            "type":"string",
            "description":"The grace period duration unit of measure. Valid values are ORA_DAYS  for day, ORA_WEEKS for weeks  , ORA_MONTHS for month, ORA_YEARS for years.",
            "nullable":true,
            "x-queryable":true
        },
        "ValidateExpFlag":{
            "title":"Expiration Validation",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the insurance expiration must be validated. Valid values are \"Y\" and \"N\".",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "ValidationOption":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the type of validation such as contractor license type or insurance. Valid values are ORA_CNT_INSURANCE, ORA_CNT_CLASSIFICATION, ORA_CNT_LICENSE_TYPE, ORA_CNT_EXPIRATION.",
            "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 number that indicates the grace period duration.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"10"
            },
            "x-queryable":true
        },
        "EnabledFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the configuration row is enabled. Valid values are \"Y\" and \"N\".",
            "nullable":false,
            "default":"N",
            "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