Jump to

• Request
• Response

Update an integration for a contractor validation option

patch

/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionIntegrations/{publicSectorContractorOptionIntegrationsUniqID}

Request

Path Parameters

• publicSectorContractorOptionIntegrationsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- LicenseSetupCode, AgencyId and IntegrationType ---for the Contractor Option Integrations resource and used to uniquely identify an instance of Contractor Option Integrations. The client should not generate the hash key value. Instead, the client should query on the Contractor Option Integrations collection resource with a filter on the primary key values in order to navigate to a specific instance of Contractor Option Integrations.
  
  For example: publicSectorContractorOptionIntegrations?q=LicenseSetupCode=<value1>;AgencyId=<value2>;IntegrationType=<value3>

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "IntegrationKey":{
            "title":"Key",
            "maxLength":"100",
            "type":"string",
            "description":"The integration source key that some external sites require for contractor license integration.",
            "nullable":true
        },
        "IntegrationName":{
            "title":"Integration Name",
            "maxLength":"1000",
            "type":"string",
            "description":"Name of an integration that maps contractor license information to the corresponding license information from an external site.",
            "nullable":true
        },
        "IntegrationParameter":{
            "title":"Integration Parameter",
            "maxLength":"100",
            "type":"string",
            "description":"Name of the query parameter that needs to be added to the integration end point.",
            "nullable":true
        },
        "IntegrationVersion":{
            "title":"Integration Version",
            "maxLength":"50",
            "type":"string",
            "description":"Version number of the integration that maps contractor license information to the corresponding license information from an external site.",
            "nullable":true
        },
        "IntegrationEnabled":{
            "title":"Integration Enabled",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether a specific named contractor license integration is active.",
            "nullable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : publicSectorContractorOptionIntegrations-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "IntegrationKey":{
            "title":"Key",
            "maxLength":"100",
            "type":"string",
            "description":"The integration source key that some external sites require for contractor license integration.",
            "nullable":true,
            "x-queryable":true
        },
        "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.",
            "nullable":false,
            "x-queryable":true
        },
        "IntegrationName":{
            "title":"Integration Name",
            "maxLength":"1000",
            "type":"string",
            "description":"Name of an integration that maps contractor license information to the corresponding license information from an external site.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"Identifier for the agency that is maintaining contractor license information.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "IntegrationVersion":{
            "title":"Integration Version",
            "maxLength":"50",
            "type":"string",
            "description":"Version number of the integration that maps contractor license information to the corresponding license information from an external site.",
            "nullable":true,
            "x-queryable":true
        },
        "IntegrationEnabled":{
            "title":"Integration Enabled",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether a specific named contractor license integration is active.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "IntegrationParameter":{
            "title":"Integration Parameter",
            "maxLength":"100",
            "type":"string",
            "description":"Name of the query parameter that needs to be added to the integration end point.",
            "nullable":true,
            "x-queryable":true
        },
        "IntegrationType":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"Identifies the type of integration such as online or batch.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top