Jump to

• Request
• Response

Update a NAICS group

patch

/fscmRestApi/resources/11.13.18.05/publicSectorNAICSGroups/{publicSectorNAICSGroupsUniqID}

Request

Supported Media Types

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

Path Parameters

• 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-item

Type: object

Show Source

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

  Maximum Length: 500

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

  Maximum Length: 1

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

  Link Relations
• NaicsGroup(optional): string
  Title: NAICS Group

  Maximum Length: 25

  The description value for a NAICS group.
• NaicsGroupCode(optional): string
  Title: NAICS Group ID

  Maximum Length: 30

  The unique identifier for a NAICS group.
• NAICSGroupCodeAccessor(optional): array NAICS Group Codes
  Title: NAICS Group Codes

  Use the NAICS group codes resource to assign NAICS codes to a group. These values are known as industry classification codes and are logically grouped for ease of selection when applying for a business license.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which the NAICS group applies."
        },
        "Description":{
            "maxLength":500,
            "type":"string",
            "description":"The long description value for a NAICS code.",
            "title":"Description"
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the NAICS group is enabled. The default value is true.",
            "title":"Enabled"
        },
        "NAICSGroupCodeAccessor":{
            "items":{
                "$ref":"#/definitions/publicSectorNAICSGroups-NAICSGroupCodeAccessor-item"
            },
            "type":"array",
            "description":"Use the NAICS group codes resource to assign NAICS codes to a group. These values are known as industry classification codes and are logically grouped for ease of selection when applying for a business license.",
            "title":"NAICS Group Codes"
        },
        "NaicsGroup":{
            "maxLength":25,
            "type":"string",
            "description":"The description value for a NAICS group.",
            "title":"NAICS Group"
        },
        "NaicsGroupCode":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for a NAICS group.",
            "title":"NAICS Group ID"
        },
        "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 : NAICS Group Codes

Type: array

Title: NAICS Group Codes

Use the NAICS group codes resource to assign NAICS codes to a group. These values are known as industry classification codes and are logically grouped for ease of selection when applying for a business license.

Show Source

• Array of: object publicSectorNAICSGroups-NAICSGroupCodeAccessor-item

{
    "items":{
        "$ref":"#/definitions/publicSectorNAICSGroups-NAICSGroupCodeAccessor-item"
    },
    "type":"array",
    "description":"Use the NAICS group codes resource to assign NAICS codes to a group. These values are known as industry classification codes and are logically grouped for ease of selection when applying for a business license.",
    "title":"NAICS Group Codes"
}

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"
}

Nested 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.

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

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

Type: object

Show Source

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

  Maximum Length: 500

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

  Maximum Length: 1

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

  Link Relations
• NaicsGroup(optional): string
  Title: NAICS Group

  Maximum Length: 25

  The description value for a NAICS group.
• NaicsGroupCode(optional): string
  Title: NAICS Group ID

  Maximum Length: 30

  The unique identifier for a NAICS group.
• NAICSGroupCodeAccessor(optional): array NAICS Group Codes
  Title: NAICS Group Codes

  Use the NAICS group codes resource to assign NAICS codes to a group. These values are known as industry classification codes and are logically grouped for ease of selection when applying for a business license.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which the NAICS group applies."
        },
        "Description":{
            "maxLength":500,
            "type":"string",
            "description":"The long description value for a NAICS code.",
            "title":"Description"
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the NAICS group is enabled. The default value is true.",
            "title":"Enabled"
        },
        "NAICSGroupCodeAccessor":{
            "items":{
                "$ref":"#/definitions/publicSectorNAICSGroups-NAICSGroupCodeAccessor-item"
            },
            "type":"array",
            "description":"Use the NAICS group codes resource to assign NAICS codes to a group. These values are known as industry classification codes and are logically grouped for ease of selection when applying for a business license.",
            "title":"NAICS Group Codes"
        },
        "NaicsGroup":{
            "maxLength":25,
            "type":"string",
            "description":"The description value for a NAICS group.",
            "title":"NAICS Group"
        },
        "NaicsGroupCode":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for a NAICS group.",
            "title":"NAICS Group ID"
        },
        "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 : NAICS Group Codes

Type: array

Title: NAICS Group Codes

Use the NAICS group codes resource to assign NAICS codes to a group. These values are known as industry classification codes and are logically grouped for ease of selection when applying for a business license.

Show Source

• Array of: object publicSectorNAICSGroups-NAICSGroupCodeAccessor-item

{
    "items":{
        "$ref":"#/definitions/publicSectorNAICSGroups-NAICSGroupCodeAccessor-item"
    },
    "type":"array",
    "description":"Use the NAICS group codes resource to assign NAICS codes to a group. These values are known as industry classification codes and are logically grouped for ease of selection when applying for a business license.",
    "title":"NAICS Group Codes"
}

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"
}

Nested 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.

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

Back to Top