Jump to

• Request
• Response

Update a contractor license detail

patch

/fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenses/{LicenseKey}/child/ContractorLicenseFacts/{LicenseFactKey}

Request

Path Parameters

• LicenseFactKey(required): integer(int64)
  The unique identifier for a detail for a contractor license.
• LicenseKey(required): integer(int64)
  The automatically generated number that uniquely identifies the contractor license.

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 ()

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

Root Schema : schema

Type: object

Show Source

• CntrctrLicFactRec: string
  Maximum Length: 30

  The type of detail record for the contractor data. For example, contractor data for a specific state might include detail sections for Status and Certifications.
• IntegrationSource: string
  Maximum Length: 30

  The external third party that validates a contractor license and its facts.
• IntLastUpdDt: string (date)
  The date when contractor license details were last updated through integration with a third-party system.
• LicenseKey: integer (int64)
  The unique identifier for a contractor license.
• LicFactCode: string
  Title: Code

  Maximum Length: 30

  The code for this detail item.
• LicFactCodeValue: string
  Title: Description

  Maximum Length: 500

  The value for this detail item.
• LicFactDate: string (date)
  Title: Date

  The date for a detail item.

{
    "type":"object",
    "properties":{
        "LicFactCode":{
            "title":"Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for this detail item.",
            "nullable":false
        },
        "LicFactCodeValue":{
            "title":"Description",
            "maxLength":500,
            "type":"string",
            "description":"The value for this detail item.",
            "nullable":true
        },
        "LicFactDate":{
            "title":"Date",
            "type":"string",
            "description":"The date for a detail item.",
            "format":"date",
            "nullable":true
        },
        "IntegrationSource":{
            "maxLength":30,
            "type":"string",
            "description":"The external third party that validates a contractor license and its facts.",
            "nullable":true
        },
        "IntLastUpdDt":{
            "type":"string",
            "description":"The date when contractor license details were last updated through integration with a third-party system.",
            "format":"date",
            "nullable":true
        },
        "CntrctrLicFactRec":{
            "maxLength":30,
            "type":"string",
            "description":"The type of detail record for the contractor data. For example, contractor data for a specific state might include detail sections for Status and Certifications.",
            "nullable":false
        },
        "LicenseKey":{
            "type":"integer",
            "description":"The unique identifier for a contractor license.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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 : publicSectorContractorLicenses-ContractorLicenseFacts-item-response

Type: object

Show Source

• CntrctrLicFactRec: string
  Maximum Length: 30

  The type of detail record for the contractor data. For example, contractor data for a specific state might include detail sections for Status and Certifications.
• IntegrationSource: string
  Maximum Length: 30

  The external third party that validates a contractor license and its facts.
• IntLastUpdDt: string (date)
  The date when contractor license details were last updated through integration with a third-party system.
• LicenseFactKey: integer (int64)
  The unique identifier for a detail for a contractor license.
• LicenseKey: integer (int64)
  The unique identifier for a contractor license.
• LicFactCode: string
  Title: Code

  Maximum Length: 30

  The code for this detail item.
• LicFactCodeValue: string
  Title: Description

  Maximum Length: 500

  The value for this detail item.
• LicFactDate: string (date)
  Title: Date

  The date for a detail item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "LicFactCode":{
            "title":"Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for this detail item.",
            "nullable":false,
            "x-queryable":true
        },
        "LicFactCodeValue":{
            "title":"Description",
            "maxLength":500,
            "type":"string",
            "description":"The value for this detail item.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LicenseFactKey":{
            "type":"integer",
            "description":"The unique identifier for a detail for a contractor license.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LicFactDate":{
            "title":"Date",
            "type":"string",
            "description":"The date for a detail item.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "IntegrationSource":{
            "maxLength":30,
            "type":"string",
            "description":"The external third party that validates a contractor license and its facts.",
            "nullable":true,
            "x-queryable":true
        },
        "IntLastUpdDt":{
            "type":"string",
            "description":"The date when contractor license details were last updated through integration with a third-party system.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CntrctrLicFactRec":{
            "maxLength":30,
            "type":"string",
            "description":"The type of detail record for the contractor data. For example, contractor data for a specific state might include detail sections for Status and Certifications.",
            "nullable":false,
            "x-queryable":true
        },
        "LicenseKey":{
            "type":"integer",
            "description":"The unique identifier for a contractor license.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "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