Jump to

• Request
• Response

Update a NAICS code

patch

/fscmRestApi/resources/11.13.18.05/publicSectorNAICSCodes/{publicSectorNAICSCodesUniqID}

Request

Supported Media Types

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

Path Parameters

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

Body ()

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

Root Schema : publicSectorNAICSCodes-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  The agency identifier of the public sector entity to which the NAICS code applies.
• Description(optional): string
  Title: Description

  Maximum Length: 4000

  The long description value for a NAICS code.
• EnabledFlag(optional): string
  Title: Enabled

  Maximum Length: 1

  Indicates whether the NAICS code is enabled. The default value is true.
• IndustryTitle(optional): string
  Title: Industry Title

  Maximum Length: 200

  The description value for a NAICS code.
• links(optional): array Items
  Title: Items

  Link Relations
• NaicsCode(optional): string
  Title: NAICS Code

  Maximum Length: 30

  The unique identifier for a NAICS code.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "description":"The agency identifier of the public sector entity to which the NAICS code applies.",
            "type":"integer",
            "format":"int32"
        },
        "Description":{
            "title":"Description",
            "description":"The long description value for a NAICS code.",
            "type":"string",
            "maxLength":4000
        },
        "EnabledFlag":{
            "title":"Enabled",
            "description":"Indicates whether the NAICS code is enabled. The default value is true.",
            "type":"string",
            "maxLength":1
        },
        "IndustryTitle":{
            "title":"Industry Title",
            "description":"The description value for a NAICS code.",
            "type":"string",
            "maxLength":200
        },
        "NaicsCode":{
            "title":"NAICS Code",
            "description":"The unique identifier for a NAICS code.",
            "type":"string",
            "maxLength":30
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

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

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.

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

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 : publicSectorNAICSCodes-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  The agency identifier of the public sector entity to which the NAICS code applies.
• Description(optional): string
  Title: Description

  Maximum Length: 4000

  The long description value for a NAICS code.
• EnabledFlag(optional): string
  Title: Enabled

  Maximum Length: 1

  Indicates whether the NAICS code is enabled. The default value is true.
• IndustryTitle(optional): string
  Title: Industry Title

  Maximum Length: 200

  The description value for a NAICS code.
• links(optional): array Items
  Title: Items

  Link Relations
• NaicsCode(optional): string
  Title: NAICS Code

  Maximum Length: 30

  The unique identifier for a NAICS code.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "description":"The agency identifier of the public sector entity to which the NAICS code applies.",
            "type":"integer",
            "format":"int32"
        },
        "Description":{
            "title":"Description",
            "description":"The long description value for a NAICS code.",
            "type":"string",
            "maxLength":4000
        },
        "EnabledFlag":{
            "title":"Enabled",
            "description":"Indicates whether the NAICS code is enabled. The default value is true.",
            "type":"string",
            "maxLength":1
        },
        "IndustryTitle":{
            "title":"Industry Title",
            "description":"The description value for a NAICS code.",
            "type":"string",
            "maxLength":200
        },
        "NaicsCode":{
            "title":"NAICS Code",
            "description":"The unique identifier for a NAICS code.",
            "type":"string",
            "maxLength":30
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

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

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.

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

Back to Top