Create a contractor license detail
post
/fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenses/{LicenseKey}/child/ContractorLicenseFacts
Request
Path Parameters
-
LicenseKey(required): integer(int64)
The automatically generated number that uniquely identifies the contractor license.
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
Root Schema : schema
Type:
Show Source
object
-
CntrctrLicFactRec: string
Maximum Length:
30
The type of detail record for the contractor data. For example, contractor data for a specific state might include detail sections for Status and Certifications. -
IntegrationSource: string
Maximum Length:
30
The external third party that validates a contractor license and its facts. -
IntLastUpdDt: string
(date)
The date when contractor license details were last updated through integration with a third-party system.
-
LicenseFactKey: integer
(int64)
The unique identifier for a detail for a contractor license.
-
LicenseKey: integer
(int64)
The unique identifier for a contractor license.
-
LicenseNumber: string
Maximum Length:
50
Default Value:The contractor license number issued by the government or the agency. -
LicenseSetupCode: string
Maximum Length:
30
Default Value:The code identifies which data sections are used for the contractor license. -
LicenseType: string
Maximum Length:
30
Default Value:The type of the issued contractor license. -
LicFactCode: string
Title:
Code
Maximum Length:30
The code for this detail item. -
LicFactCodeValue: string
Title:
Description
Maximum Length:500
The value for this detail item. -
LicFactDate: string
(date)
Title:
Date
The date for a detail item.
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 : publicSectorContractorLicenses-ContractorLicenseFacts-item-response
Type:
Show Source
object
-
CntrctrLicFactRec: string
Maximum Length:
30
The type of detail record for the contractor data. For example, contractor data for a specific state might include detail sections for Status and Certifications. -
IntegrationSource: string
Maximum Length:
30
The external third party that validates a contractor license and its facts. -
IntLastUpdDt: string
(date)
The date when contractor license details were last updated through integration with a third-party system.
-
LicenseFactKey: integer
(int64)
The unique identifier for a detail for a contractor license.
-
LicenseKey: integer
(int64)
The unique identifier for a contractor license.
-
LicenseNumber: string
Maximum Length:
50
Default Value:The contractor license number issued by the government or the agency. -
LicenseSetupCode: string
Maximum Length:
30
Default Value:The code identifies which data sections are used for the contractor license. -
LicenseType: string
Maximum Length:
30
Default Value:The type of the issued contractor license. -
LicFactCode: string
Title:
Code
Maximum Length:30
The code for this detail item. -
LicFactCodeValue: string
Title:
Description
Maximum Length:500
The value for this detail item. -
LicFactDate: string
(date)
Title:
Date
The date for a detail item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
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.