Update a contractor validation fact
patch
/fscmRestApi/resources/11.13.18.05/publicSectorContractorFacts/{publicSectorContractorFactsUniqID}
Request
Path Parameters
-
publicSectorContractorFactsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- FactSection and AgencyId ---for the Contractor Facts resource and used to uniquely identify an instance of Contractor Facts. The client should not generate the hash key value. Instead, the client should query on the Contractor Facts collection resource with a filter on the primary key values in order to navigate to a specific instance of Contractor Facts.
For example: publicSectorContractorFacts?q=FactSection=<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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
Description: string
Title:
Description
Maximum Length:100
The description of a specific contractor license fact within a fact section. -
SeedDataLock: integer
(int32)
Indicates whether the row is seed data. Valid values are 0 for data that is customer data, 1 for seed data that cannot be modified, and 2 for seed data that customers can modify.
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 : publicSectorContractorFacts-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
The agency that is maintaining contractor license information.
-
DeletedFlag: string
Maximum Length:
1
Indicates whether the record is logically deleted. If the value is Y, the record has been logically deleted. The default value is N. -
Description: string
Title:
Description
Maximum Length:100
The description of a specific contractor license fact within a fact section. -
FactSection: string
Title:
Code
Maximum Length:30
The fact group to which a fact belongs. -
FactType: string
Maximum Length:
30
Categorizes a fact section as either insurance-related facts or other facts. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SeedDataLock: integer
(int32)
Indicates whether the row is seed data. Valid values are 0 for data that is customer data, 1 for seed data that cannot be modified, and 2 for seed data that customers can modify.
-
SeedDataSource: string
Maximum Length:
512
Identifies the seed data bulk loading file that this row of data originated from.
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.