Update a validation group detail value set
patch
/fscmRestApi/resources/11.13.18.05/publicSectorValidationGroupDetails/{publicSectorValidationGroupDetailsUniqID}/child/ValidationGroupDetailValueSets/{ValidationGroupDetailValueSetsUniqID}
Request
Path Parameters
-
ValidationGroupDetailValueSetsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- AgencyId, ValidationDetType, ValidationDetValue, ValidationGroupId, ValidationOption and ValidationValue ---for the Validation Group Detail Value Sets resource and used to uniquely identify an instance of Validation Group Detail Value Sets. The client should not generate the hash key value. Instead, the client should query on the Validation Group Detail Value Sets collection resource with a filter on the primary key values in order to navigate to a specific instance of Validation Group Detail Value Sets.
For example: ValidationGroupDetailValueSets?q=AgencyId=<value1>;ValidationDetType=<value2>;ValidationDetValue=<value3>;ValidationGroupId=<value4>;ValidationOption=<value5>;ValidationValue=<value6> -
publicSectorValidationGroupDetailsUniqID(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: publicSectorValidationGroupDetails?q=ValidationGroupId=<value1>;ValidationOption=<value2>;AgencyId=<value3>
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
Root Schema : schema
Type:
Show Source
object
-
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 indicating 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 needs to be validated. Valid values are "Y" and "N". -
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.
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.
Root Schema : publicSectorValidationGroupDetails-ValidationGroupDetailValueSets-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
The agency identifier. -
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 indicating 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 needs to 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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.