Jump to

• Request
• Response

Update a status mapping for a contractor validation option is not allowed

patch

/fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}/child/ContractorOptionStatusMappings/{ContractorOptionStatusMappingsUniqID}

Request

Supported Media Types

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

Path Parameters

• ContractorOptionStatusMappingsUniqID: integer
  This is the hash key of the attributes which make up the composite key--- LicenseSetupCode, AgencyId and SourceStatus ---for the Contractor Option Status Mappings resource and used to uniquely identify an instance of Contractor Option Status Mappings. The client should not generate the hash key value. Instead, the client should query on the Contractor Option Status Mappings collection resource with a filter on the primary key values in order to navigate to a specific instance of Contractor Option Status Mappings.
  
  For example: ContractorOptionStatusMappings?q=LicenseSetupCode=<value1>;AgencyId=<value2>;SourceStatus=<value3>
• publicSectorRegContractorOptionsUniqID: 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: publicSectorRegContractorOptions?q=LicenseSetupCode=<value1>;AgencyId=<value2>

Body ()

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

Root Schema : publicSectorRegContractorOptions-ContractorOptionStatusMappings-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Identifier for the agency that is maintaining contractor license information.
• DeclineApplication(optional): string
  Maximum Length: 1

  Indicates if applications that are associated with the specified contractor license status should be declined.
• Enabled(optional): string
  Maximum Length: 1

  Status of the mapping that indicates if the mapping is active or inactive.
• InternalStatus(optional): string
  Maximum Length: 30

  The agency-assigned status for a contractor license that corresponds to the status assigned by the third-party licensing body.
• 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
• SourceStatus(optional): string
  Maximum Length: 100

  Contractor license status that is assigned by a third party licensing body.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"Identifier for the agency that is maintaining contractor license information."
        },
        "DeclineApplication":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if applications that are associated with the specified contractor license status should be declined."
        },
        "Enabled":{
            "maxLength":1,
            "type":"string",
            "description":"Status of the mapping that indicates if the mapping is active or inactive."
        },
        "InternalStatus":{
            "maxLength":30,
            "type":"string",
            "description":"The agency-assigned status for a contractor license that corresponds to the status assigned by the third-party licensing body."
        },
        "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."
        },
        "SourceStatus":{
            "maxLength":100,
            "type":"string",
            "description":"Contractor license status that is assigned by a third party licensing body."
        },
        "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 : publicSectorRegContractorOptions-ContractorOptionStatusMappings-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Identifier for the agency that is maintaining contractor license information.
• DeclineApplication(optional): string
  Maximum Length: 1

  Indicates if applications that are associated with the specified contractor license status should be declined.
• Enabled(optional): string
  Maximum Length: 1

  Status of the mapping that indicates if the mapping is active or inactive.
• InternalStatus(optional): string
  Maximum Length: 30

  The agency-assigned status for a contractor license that corresponds to the status assigned by the third-party licensing body.
• 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
• SourceStatus(optional): string
  Maximum Length: 100

  Contractor license status that is assigned by a third party licensing body.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"Identifier for the agency that is maintaining contractor license information."
        },
        "DeclineApplication":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if applications that are associated with the specified contractor license status should be declined."
        },
        "Enabled":{
            "maxLength":1,
            "type":"string",
            "description":"Status of the mapping that indicates if the mapping is active or inactive."
        },
        "InternalStatus":{
            "maxLength":30,
            "type":"string",
            "description":"The agency-assigned status for a contractor license that corresponds to the status assigned by the third-party licensing body."
        },
        "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."
        },
        "SourceStatus":{
            "maxLength":100,
            "type":"string",
            "description":"Contractor license status that is assigned by a third party licensing body."
        },
        "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