Jump to

• Request
• Response

Update a NAICS group code

patch

/fscmRestApi/resources/11.13.18.05/publicSectorNAICSGroups/{publicSectorNAICSGroupsUniqID}/child/NAICSGroupCodeAccessor/{NAICSGroupCodeAccessorUniqID}

Request

Supported Media Types

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

Path Parameters

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

Body ()

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

Root Schema : publicSectorNAICSGroups-NAICSGroupCodeAccessor-item

Type: object

Show Source

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

  Maximum Length: 1

  Indicates whether the NAICS group code is enabled. The default value is true.
• links(optional): array Items
  Title: Items

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

  Maximum Length: 30

  The unique identifier for a NAICS code.
• NaicsGroupCode(optional): string
  Maximum Length: 30

  The unique identifier for a NAICS group.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "description":"The agency identifier of the public sector entity to which the NAICS group code applies.",
            "type":"integer",
            "format":"int32"
        },
        "EnabledFlag":{
            "title":"Enabled",
            "description":"Indicates whether the NAICS group code is enabled. The default value is true.",
            "type":"string",
            "maxLength":1
        },
        "NaicsCode":{
            "title":"NAICS Code",
            "description":"The unique identifier for a NAICS code.",
            "type":"string",
            "maxLength":30
        },
        "NaicsGroupCode":{
            "description":"The unique identifier for a NAICS group.",
            "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 : publicSectorNAICSGroups-NAICSGroupCodeAccessor-item

Type: object

Show Source

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

  Maximum Length: 1

  Indicates whether the NAICS group code is enabled. The default value is true.
• links(optional): array Items
  Title: Items

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

  Maximum Length: 30

  The unique identifier for a NAICS code.
• NaicsGroupCode(optional): string
  Maximum Length: 30

  The unique identifier for a NAICS group.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "description":"The agency identifier of the public sector entity to which the NAICS group code applies.",
            "type":"integer",
            "format":"int32"
        },
        "EnabledFlag":{
            "title":"Enabled",
            "description":"Indicates whether the NAICS group code is enabled. The default value is true.",
            "type":"string",
            "maxLength":1
        },
        "NaicsCode":{
            "title":"NAICS Code",
            "description":"The unique identifier for a NAICS code.",
            "type":"string",
            "maxLength":30
        },
        "NaicsGroupCode":{
            "description":"The unique identifier for a NAICS group.",
            "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