Create a set of integrations for a contractor validation option
post
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}/child/ContractorOptionIntegrations
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
publicSectorContractorOptionsUniqID: integer
This is the hash key of the attributes which make up the composite key--- LicenseSetupCode and AgencyId ---for the Contractor Options resource and used to uniquely identify an instance of Contractor Options. The client should not generate the hash key value. Instead, the client should query on the Contractor Options collection resource with a filter on the primary key values in order to navigate to a specific instance of Contractor Options.
For example: publicSectorContractorOptions?q=LicenseSetupCode=<value1>;AgencyId=<value2>
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorContractorOptions-ContractorOptionIntegrations-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Identifier for the agency that is maintaining contractor license information.
-
IntegrationEnabled(optional):
string
Maximum Length:
1
Indicates whether a specific named contractor license integration is active. -
IntegrationKey(optional):
string
Maximum Length:
100
The integration source key that some external sites require for contractor license integration. -
IntegrationName(optional):
string
Maximum Length:
1000
Name of an integration that maps contractor license information to the corresponding license information from an external site. -
IntegrationParameter(optional):
string
Maximum Length:
100
Name of the query parameter that needs to be added to the integration end point. -
IntegrationType(optional):
string
Maximum Length:
30
Identifies the type of integration such as online or batch. -
IntegrationVersion(optional):
string
Maximum Length:
50
Version number of the integration that maps contractor license information to the corresponding license information from an external site. -
LicenseSetupCode(optional):
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(optional):
array Items
Title:
Items
Link Relations
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorContractorOptions-ContractorOptionIntegrations-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Identifier for the agency that is maintaining contractor license information.
-
IntegrationEnabled(optional):
string
Maximum Length:
1
Indicates whether a specific named contractor license integration is active. -
IntegrationKey(optional):
string
Maximum Length:
100
The integration source key that some external sites require for contractor license integration. -
IntegrationName(optional):
string
Maximum Length:
1000
Name of an integration that maps contractor license information to the corresponding license information from an external site. -
IntegrationParameter(optional):
string
Maximum Length:
100
Name of the query parameter that needs to be added to the integration end point. -
IntegrationType(optional):
string
Maximum Length:
30
Identifies the type of integration such as online or batch. -
IntegrationVersion(optional):
string
Maximum Length:
50
Version number of the integration that maps contractor license information to the corresponding license information from an external site. -
LicenseSetupCode(optional):
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(optional):
array Items
Title:
Items
Link Relations
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.