Update a tag group
patch
/fscmRestApi/resources/11.13.18.05/hedTagGroups/{TagGroupId}
Request
Path Parameters
-
TagGroupId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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
-
associatedTags: array
Associated Tags
Title:
Associated Tags
The associated tags resource is used to manage associated tags of the tag group. -
EnabledFlag: boolean
Maximum Length:
1
Indicates whether a tag group is enabled. -
TagGroupCode: string
Title:
Tag Group Code
Maximum Length:30
Alternate identifier for a tag group. -
TagGroupDescription: string
Title:
Tag Group Description
Maximum Length:240
Description for a tag group. -
TagGroupName: string
Title:
Tag Group Name
Maximum Length:64
Name for a tag group.
Nested Schema : Associated Tags
Type:
array
Title:
Associated Tags
The associated tags resource is used to manage associated tags of the tag group.
Show Source
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 : hedTagGroups-item-response
Type:
Show Source
object
-
associatedTags: array
Associated Tags
Title:
Associated Tags
The associated tags resource is used to manage associated tags of the tag group. -
EnabledFlag: boolean
Maximum Length:
1
Indicates whether a tag group is enabled. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SeedDataFlag: boolean
Read Only:
true
Default Value:false
Indicates whether a tag group is predefined. -
TagCount: integer
Read Only:
true
Number of associated tags. -
TagGroupCode: string
Title:
Tag Group Code
Maximum Length:30
Alternate identifier for a tag group. -
TagGroupDescription: string
Title:
Tag Group Description
Maximum Length:240
Description for a tag group. -
TagGroupId: integer
(int64)
Read Only:
true
Unique identifier of the tag group. -
TagGroupName: string
Title:
Tag Group Name
Maximum Length:64
Name for a tag group.
Nested Schema : Associated Tags
Type:
array
Title:
Associated Tags
The associated tags resource is used to manage associated tags of the tag group.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : hedTagGroups-associatedTags-item-response
Type:
Show Source
object
-
AssociatedTagId: integer
(int64)
Read Only:
true
Description for an associated tag. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TagCode: string
Read Only:
true
Maximum Length:30
Unique identifier for the mapping between a tag group and a tag. -
TagDescription: string
Read Only:
true
Maximum Length:240
Code for an associated tag. -
TagId: integer
(int64)
Identifier for an associated tag.
-
TagName: string
Read Only:
true
Maximum Length:64
Name for an associated tag.
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.
Links
- associatedTags
-
Parameters:
- TagGroupId:
$request.path.TagGroupId
The associated tags resource is used to manage associated tags of the tag group. - TagGroupId: