Jump to

• Request
• Response

Update a fact for contractor validation option

patch

/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptionFacts/{publicSectorContractorOptionFactsUniqID}

Request

Supported Media Types

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

Path Parameters

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

Body ()

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

Root Schema : publicSectorContractorOptionFacts-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Identifier for the agency that is maintaining contractor license validation.
• Description(optional): string
  The description of a specific contractor license fact within a fact section.
• FactSection(optional): string
  Maximum Length: 30

  The type of fact record for the contractor data. For example, contractor data for a specific state might include fact sections for classifications.
• 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
• SectionEnabled(optional): string
  Maximum Length: 1

  Indicates whether a specific fact section should be included when contractor license data appears on pages.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"Identifier for the agency that is maintaining contractor license validation."
        },
        "Description":{
            "type":"string",
            "description":"The description of a specific contractor license fact within a fact section."
        },
        "FactSection":{
            "maxLength":30,
            "type":"string",
            "description":"The type of fact record for the contractor data. For example, contractor data for a specific state might include fact sections for classifications."
        },
        "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."
        },
        "SectionEnabled":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether a specific fact section should be included when contractor license data appears on pages."
        },
        "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 : publicSectorContractorOptionFacts-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Identifier for the agency that is maintaining contractor license validation.
• Description(optional): string
  The description of a specific contractor license fact within a fact section.
• FactSection(optional): string
  Maximum Length: 30

  The type of fact record for the contractor data. For example, contractor data for a specific state might include fact sections for classifications.
• 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
• SectionEnabled(optional): string
  Maximum Length: 1

  Indicates whether a specific fact section should be included when contractor license data appears on pages.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"Identifier for the agency that is maintaining contractor license validation."
        },
        "Description":{
            "type":"string",
            "description":"The description of a specific contractor license fact within a fact section."
        },
        "FactSection":{
            "maxLength":30,
            "type":"string",
            "description":"The type of fact record for the contractor data. For example, contractor data for a specific state might include fact sections for classifications."
        },
        "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."
        },
        "SectionEnabled":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether a specific fact section should be included when contractor license data appears on pages."
        },
        "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