Jump to

• Request
• Response

Create a set of integrations for a contractor validation option

post

/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionIntegrations

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorContractorOptionIntegrations-item

Type: object

Show Source

• 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

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"Identifier for the agency that is maintaining contractor license information."
        },
        "IntegrationEnabled":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether a specific named contractor license integration is active."
        },
        "IntegrationKey":{
            "maxLength":100,
            "type":"string",
            "description":"The integration source key that some external sites require for contractor license integration."
        },
        "IntegrationName":{
            "maxLength":1000,
            "type":"string",
            "description":"Name of an integration that maps contractor license information to the corresponding license information from an external site."
        },
        "IntegrationParameter":{
            "maxLength":100,
            "type":"string",
            "description":"Name of the query parameter that needs to be added to the integration end point."
        },
        "IntegrationType":{
            "maxLength":30,
            "type":"string",
            "description":"Identifies the type of integration such as online or batch."
        },
        "IntegrationVersion":{
            "maxLength":50,
            "type":"string",
            "description":"Version number of the integration that maps contractor license information to the corresponding license information from an external site."
        },
        "LicenseSetupCode":{
            "maxLength":30,
            "type":"string",
            "description":"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":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorContractorOptionIntegrations-item

Type: object

Show Source

• 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

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"Identifier for the agency that is maintaining contractor license information."
        },
        "IntegrationEnabled":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether a specific named contractor license integration is active."
        },
        "IntegrationKey":{
            "maxLength":100,
            "type":"string",
            "description":"The integration source key that some external sites require for contractor license integration."
        },
        "IntegrationName":{
            "maxLength":1000,
            "type":"string",
            "description":"Name of an integration that maps contractor license information to the corresponding license information from an external site."
        },
        "IntegrationParameter":{
            "maxLength":100,
            "type":"string",
            "description":"Name of the query parameter that needs to be added to the integration end point."
        },
        "IntegrationType":{
            "maxLength":30,
            "type":"string",
            "description":"Identifies the type of integration such as online or batch."
        },
        "IntegrationVersion":{
            "maxLength":50,
            "type":"string",
            "description":"Version number of the integration that maps contractor license information to the corresponding license information from an external site."
        },
        "LicenseSetupCode":{
            "maxLength":30,
            "type":"string",
            "description":"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":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top