Update a category
patch
/fscmRestApi/resources/11.13.18.05/itemCategories/{itemCategoriesUniqID}
Request
Path Parameters
-
itemCategoriesUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Item Categories resource and used to uniquely identify an instance of Item Categories. The client should not generate the hash key value. Instead, the client should query on the Item Categories collection resource in order to navigate to a specific instance of Item Categories to get the hash key.
Header Parameters
-
Metadata-Context: string
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: string
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-
attachments: array
Attachments
Title:
AttachmentsThe Attachments resource manages the catalog attachments. -
CatalogCode: string
Maximum Length:
255Abbreviation that identifies the item catalog. -
CategoryCode: string
Maximum Length:
820Abbreviation that identifies the item category in user interface. -
CategoryName: string
Maximum Length:
250Name of the category. -
Description: string
Maximum Length:
240Description of the category. -
DFF: array
DFF
-
EndDate: string
(date)
Date when the category becomes inactive.
-
ItemsOnlyFlag: boolean
Title:
Category ContentMaximum Length:30Default Value:falseContains one of the following values: true or false. If true, then the category can have only items assigned to it. If false, the category can have both items and child categories assigned to it. The default value is false. -
ParentCategoryCode: string
Maximum Length:
255Abbreviation that identifies the parent category in a category hierarchy. -
StartDate: string
(date)
Date when the item category becomes active.
-
translatableAttributes: array
Translatable Attributes
Title:
Translatable AttributesThe Translatable Attributes resource manages the translatable attributes of categories.
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe Attachments resource manages the catalog attachments.
Show Source
Nested Schema : Translatable Attributes
Type:
arrayTitle:
Translatable AttributesThe Translatable Attributes resource manages the translatable attributes of categories.
Show Source
Nested Schema : itemCategories-attachments-item-patch-request
Type:
Show Source
object-
attachmentDFF: array
Descriptive Flexfields for Attachments
Title:
Descriptive Flexfields for AttachmentsThe Descriptive Flexfields for Attachments resource manages the contextual descriptive flexfields of the category attachments. -
CategoryName: string
Title:
CategoryMaximum Length:30Name of the catalog attachment category. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Attachment Categories task. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEAbbreviation that indicates the type of data. Valid values include WEB_PAGE, TEXT, or FILE. -
Description: string
Title:
DescriptionMaximum Length:255Description of the catalog attachment. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000Path to the folder in which the attached file is uploaded. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeAbbreviation that identifies the error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageText of the error message, if any, for the attachment. -
FileName: string
Title:
File NameMaximum Length:2048Name of the file attached to the item. -
FileUrl: string
Title:
File UrlUniform resource locator of the attachment file. -
Title: string
Title:
TitleTitle of the catalog attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeType of the file content. -
UploadedFileLength: integer
Title:
File SizeSize of the attached file. -
UploadedFileName: string
Title:
Uploaded File NameName of the attached file. -
UploadedText: string
Title:
Uploaded TextContent of the attached text file. -
Uri: string
Title:
UriMaximum Length:4000Uniform resource identifier appended to the base URI derived from the endpoint associated with application identified by the MODULE_ID. -
Url: string
Title:
UrlMaximum Length:4000Uniform resource locator of the attachment.
Nested Schema : Descriptive Flexfields for Attachments
Type:
arrayTitle:
Descriptive Flexfields for AttachmentsThe Descriptive Flexfields for Attachments resource manages the contextual descriptive flexfields of the category attachments.
Show Source
Nested Schema : itemCategories-attachments-attachmentDFF-item-patch-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:150Descriptive flexfield context name for item category attachments. -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentDescriptive flexfield context display value for item category attachments. -
AttachedDocumentId: integer
(int64)
Nested Schema : itemCategories-DFF-item-patch-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value
Nested Schema : schema
Type:
Show Source
object-
CategoryId: integer
(int64)
Value that uniquely identifies the category.
-
CategoryName: string
Title:
Category NameMaximum Length:2400Translated name of the category. -
Description: string
Maximum Length:
240Translated description of the category. -
SourceLanguage: string
Maximum Length:
4Language associated with the translated source category attributes.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
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.
Root Schema : itemCategories-item-response
Type:
Show Source
object-
attachments: array
Attachments
Title:
AttachmentsThe Attachments resource manages the catalog attachments. -
CatalogCode: string
Maximum Length:
255Abbreviation that identifies the item catalog. -
CatalogControlLevel: integer
(int32)
Title:
Controlled AtRead Only:trueAttribute for the catalog control level. -
CatalogControlLevelValue: string
Read Only:
trueMaximum Length:255Value for the catalog control level. -
CatalogId: integer
Value that uniquely identifies the item catalog.
-
CatalogName: string
Read Only:
trueMaximum Length:30Name of the catalog. -
CategoryCode: string
Maximum Length:
820Abbreviation that identifies the item category in user interface. -
CategoryId: integer
(int64)
Title:
Default CategoryValue that uniquely identifies the item category. This value should not be used in service calls to create categories in catalogs. -
CategoryName: string
Maximum Length:
250Name of the category. -
CreationDateTime: string
(date-time)
Read Only:
trueDate and time when the user created the category. -
Description: string
Maximum Length:
240Description of the category. -
DFF: array
DFF
-
EndDate: string
(date)
Date when the category becomes inactive.
-
ItemsOnlyFlag: boolean
Title:
Category ContentMaximum Length:30Default Value:falseContains one of the following values: true or false. If true, then the category can have only items assigned to it. If false, the category can have both items and child categories assigned to it. The default value is false. -
LastUpdateDateTime: string
(date-time)
Read Only:
trueDate and time when the user most recently updated the category. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ParentCategoryCode: string
Maximum Length:
255Abbreviation that identifies the parent category in a category hierarchy. - SharedFlag: boolean
-
StartDate: string
(date)
Date when the item category becomes active.
-
translatableAttributes: array
Translatable Attributes
Title:
Translatable AttributesThe Translatable Attributes resource manages the translatable attributes of categories.
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe Attachments resource manages the catalog attachments.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Translatable Attributes
Type:
arrayTitle:
Translatable AttributesThe Translatable Attributes resource manages the translatable attributes of categories.
Show Source
Nested Schema : itemCategories-attachments-item-response
Type:
Show Source
object-
attachmentDFF: array
Descriptive Flexfields for Attachments
Title:
Descriptive Flexfields for AttachmentsThe Descriptive Flexfields for Attachments resource manages the contextual descriptive flexfields of the category attachments. -
CategoryName: string
Title:
CategoryMaximum Length:30Name of the catalog attachment category. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Attachment Categories task. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255User who created the attachment. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate when the user created the attachment. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEAbbreviation that indicates the type of data. Valid values include WEB_PAGE, TEXT, or FILE. -
Description: string
Title:
DescriptionMaximum Length:255Description of the catalog attachment. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000Path to the folder in which the attached file is uploaded. -
DocumentURL: string
Read Only:
trueUniform resource locator of the catalog attachment. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeAbbreviation that identifies the error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageText of the error message, if any, for the attachment. -
FileName: string
Title:
File NameMaximum Length:2048Name of the file attached to the item. -
FileUrl: string
Title:
File UrlUniform resource locator of the attachment file. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueDate when the user most recently updated the attachment. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255User who most recently updated the attachment. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Title: string
Title:
TitleTitle of the catalog attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeType of the file content. -
UploadedFileLength: integer
Title:
File SizeSize of the attached file. -
UploadedFileName: string
Title:
Uploaded File NameName of the attached file. -
UploadedText: string
Title:
Uploaded TextContent of the attached text file. -
Uri: string
Title:
UriMaximum Length:4000Uniform resource identifier appended to the base URI derived from the endpoint associated with application identified by the MODULE_ID. -
Url: string
Title:
UrlMaximum Length:4000Uniform resource locator of the attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255Display name of the attachment category. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage attachment categories task.
Nested Schema : Descriptive Flexfields for Attachments
Type:
arrayTitle:
Descriptive Flexfields for AttachmentsThe Descriptive Flexfields for Attachments resource manages the contextual descriptive flexfields of the category attachments.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : itemCategories-attachments-attachmentDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:150Descriptive flexfield context name for item category attachments. -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentDescriptive flexfield context display value for item category attachments. -
AttachedDocumentId: integer
(int64)
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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.
Nested Schema : itemCategories-DFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
CategoryId: integer
(int64)
Title:
Default Category -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : itemCategories-translatableAttributes-item-response
Type:
Show Source
object-
CategoryId: integer
(int64)
Value that uniquely identifies the category.
-
CategoryName: string
Title:
Category NameMaximum Length:2400Translated name of the category. -
CreationDateTime: string
(date-time)
Read Only:
trueDate and time when the user created the translatable attributes of the category. -
Description: string
Maximum Length:
240Translated description of the category. -
Language: string
Maximum Length:
4Language associated with the translated attributes. -
LastUpdateDateTime: string
(date-time)
Read Only:
trueDate and time when the user most recently updated the translatable attributes of the category. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
SourceLanguage: string
Maximum Length:
4Language associated with the translated source category attributes.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- DFF
-
Parameters:
- itemCategoriesUniqID:
$request.path.itemCategoriesUniqID
- itemCategoriesUniqID:
- attachments
-
Operation: /fscmRestApi/resources/11.13.18.05/itemCategories/{itemCategoriesUniqID}/child/attachmentsParameters:
- itemCategoriesUniqID:
$request.path.itemCategoriesUniqID
The Attachments resource manages the catalog attachments. - itemCategoriesUniqID:
- itemCatalogsLOV
-
Abbreviation that identifies the item catalog.
- parentCategoriesLOV
-
Parameters:
- finder:
findParentCategories%3BBind_CatalogCode%3D{CatalogCode}
Abbreviation that identifies the parent category. - finder:
- translatableAttributes
-
Parameters:
- itemCategoriesUniqID:
$request.path.itemCategoriesUniqID
The Translatable Attributes resource manages the translatable attributes of categories. - itemCategoriesUniqID: