Create a set of integrations for a contractor validation option
post
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionIntegrations
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:
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
-
AgencyId: integer
(int32)
Identifier for the agency that is maintaining contractor license information.
-
IntegrationEnabled: string
Title:
Integration Enabled
Maximum Length:1
Indicates whether a specific named contractor license integration is active. -
IntegrationKey: string
Title:
Key
Maximum Length:100
The integration source key that some external sites require for contractor license integration. -
IntegrationName: string
Title:
Integration Name
Maximum Length:1000
Name of an integration that maps contractor license information to the corresponding license information from an external site. -
IntegrationParameter: string
Title:
Integration Parameter
Maximum Length:100
Name of the query parameter that needs to be added to the integration end point. -
IntegrationType: string
Title:
Type
Maximum Length:30
Identifies the type of integration such as online or batch. -
IntegrationVersion: string
Title:
Integration Version
Maximum Length:50
Version number of the integration that maps contractor license information to the corresponding license information from an external site. -
LicenseSetupCode: string
Maximum Length:
30
Code that identifies a set of configuration options for contractor licenses. For example, a code might represent configuration options that include integration with the state licensing board in California.
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 : publicSectorContractorOptionIntegrations-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Identifier for the agency that is maintaining contractor license information.
-
IntegrationEnabled: string
Title:
Integration Enabled
Maximum Length:1
Indicates whether a specific named contractor license integration is active. -
IntegrationKey: string
Title:
Key
Maximum Length:100
The integration source key that some external sites require for contractor license integration. -
IntegrationName: string
Title:
Integration Name
Maximum Length:1000
Name of an integration that maps contractor license information to the corresponding license information from an external site. -
IntegrationParameter: string
Title:
Integration Parameter
Maximum Length:100
Name of the query parameter that needs to be added to the integration end point. -
IntegrationType: string
Title:
Type
Maximum Length:30
Identifies the type of integration such as online or batch. -
IntegrationVersion: string
Title:
Integration Version
Maximum Length:50
Version number of the integration that maps contractor license information to the corresponding license information from an external site. -
LicenseSetupCode: string
Maximum Length:
30
Code that identifies a set of configuration options for contractor licenses. For example, a code might represent configuration options that include integration with the state licensing board in California. -
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.