Update a NAICS group code
patch
/fscmRestApi/resources/11.13.18.05/publicSectorNAICSGroupCodes/{publicSectorNAICSGroupCodesUniqID}
Request
Path Parameters
-
publicSectorNAICSGroupCodesUniqID(required): string
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: publicSectorNAICSGroupCodes?q=AgencyId=<value1>;NaicsGroupCode=<value2>;NaicsCode=<value3>
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
Root Schema : schema
Type:
Show Source
object
-
EnabledFlag: string
Title:
Enabled
Maximum Length:1
Indicates whether the NAICS group code is enabled. The default value is true.
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.
Root Schema : publicSectorNAICSGroupCodes-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
The agency identifier of the public sector entity to which the NAICS group code applies. -
EnabledFlag: string
Title:
Enabled
Maximum Length:1
Indicates whether the NAICS group code is enabled. The default value is true. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NaicsCode: string
Title:
NAICS Code
Maximum Length:30
The unique identifier for a NAICS code. -
NaicsGroupCode: string
Maximum Length:
30
The unique identifier for a NAICS group.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.