Create categories
post
/fscmRestApi/resources/11.13.18.05/itemCategories
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
attachments: array
Attachments
Title:
Attachments
The Attachments resource manages the catalog attachments. -
CatalogCode: string
Maximum Length:
255
Abbreviation that identifies the item catalog. -
CatalogId(required): integer
Value that uniquely identifies the item catalog.
-
CategoryCode(required): string
Maximum Length:
820
Abbreviation that identifies the item category in user interface. -
CategoryId: integer
(int64)
Title:
Default Category
Value that uniquely identifies the item category. This value should not be used in service calls to create categories in catalogs. -
CategoryName(required): string
Maximum Length:
250
Name of the category. -
Description: string
Maximum Length:
240
Description of the category. -
DFF: array
DFF
-
EndDate: string
(date)
Date when the category becomes inactive.
-
ItemsOnlyFlag: boolean
Title:
Category Content
Maximum Length:30
Default Value:false
Contains 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:
255
Abbreviation 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 Attributes
The Translatable Attributes resource manages the translatable attributes of categories.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The Attachments resource manages the catalog attachments.
Show Source
Nested Schema : Translatable Attributes
Type:
array
Title:
Translatable Attributes
The Translatable Attributes resource manages the translatable attributes of categories.
Show Source
Nested Schema : itemCategories-attachments-item-post-request
Type:
Show Source
object
-
attachmentDFF: array
Descriptive Flexfields for Attachments
Title:
Descriptive Flexfields for Attachments
The Descriptive Flexfields for Attachments resource manages the contextual descriptive flexfields of the category attachments. -
CategoryName: string
Title:
Category
Maximum Length:30
Name 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:
Type
Maximum Length:30
Default Value:FILE
Abbreviation that indicates the type of data. Valid values include WEB_PAGE, TEXT, or FILE. -
Description: string
Title:
Description
Maximum Length:255
Description of the catalog attachment. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Path to the folder in which the attached file is uploaded. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Abbreviation that identifies the error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Text of the error message, if any, for the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
Name of the file attached to the item. -
FileUrl: string
Title:
File Url
Uniform resource locator of the attachment file. -
Title: string
Title:
Title
Title of the catalog attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Type of the file content. -
UploadedFileLength: integer
Title:
File Size
Size of the attached file. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the attached file. -
UploadedText: string
Title:
Uploaded Text
Content of the attached text file. -
Uri: string
Title:
Uri
Maximum Length:4000
Uniform resource identifier appended to the base URI derived from the endpoint associated with application identified by the MODULE_ID. -
Url: string
Title:
Url
Maximum Length:4000
Uniform resource locator of the attachment.
Nested Schema : Descriptive Flexfields for Attachments
Type:
array
Title:
Descriptive Flexfields for Attachments
The Descriptive Flexfields for Attachments resource manages the contextual descriptive flexfields of the category attachments.
Show Source
Nested Schema : itemCategories-attachments-attachmentDFF-item-post-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
Descriptive flexfield context name for item category attachments. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Descriptive flexfield context display value for item category attachments. -
AttachedDocumentId: integer
(int64)
Nested Schema : itemCategories-DFF-item-post-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
CategoryId: integer
(int64)
Title:
Default Category
Nested Schema : itemCategories-translatableAttributes-item-post-request
Type:
Show Source
object
-
CategoryId: integer
(int64)
Value that uniquely identifies the category.
-
CategoryName: string
Title:
Category Name
Maximum Length:2400
Translated name of the category. -
Description: string
Maximum Length:
240
Translated description of the category. -
Language: string
Maximum Length:
4
Language associated with the translated attributes. -
SourceLanguage: string
Maximum Length:
4
Language 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(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 : itemCategories-item-response
Type:
Show Source
object
-
attachments: array
Attachments
Title:
Attachments
The Attachments resource manages the catalog attachments. -
CatalogCode: string
Maximum Length:
255
Abbreviation that identifies the item catalog. -
CatalogId: integer
Value that uniquely identifies the item catalog.
-
CategoryCode: string
Maximum Length:
820
Abbreviation that identifies the item category in user interface. -
CategoryId: integer
(int64)
Title:
Default Category
Value that uniquely identifies the item category. This value should not be used in service calls to create categories in catalogs. -
CategoryName: string
Maximum Length:
250
Name of the category. -
CreationDateTime: string
(date-time)
Read Only:
true
Date and time when the user created the category. -
Description: string
Maximum Length:
240
Description of the category. -
DFF: array
DFF
-
EndDate: string
(date)
Date when the category becomes inactive.
-
ItemsOnlyFlag: boolean
Title:
Category Content
Maximum Length:30
Default Value:false
Contains 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:
true
Date and time when the user most recently updated the category. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ParentCategoryCode: string
Maximum Length:
255
Abbreviation 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 Attributes
The Translatable Attributes resource manages the translatable attributes of categories.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The Attachments resource manages the catalog attachments.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Translatable Attributes
Type:
array
Title:
Translatable Attributes
The 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 Attachments
The Descriptive Flexfields for Attachments resource manages the contextual descriptive flexfields of the category attachments. -
CategoryName: string
Title:
Category
Maximum Length:30
Name 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 By
Read Only:true
Maximum Length:255
User who created the attachment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the user created the attachment. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Abbreviation that indicates the type of data. Valid values include WEB_PAGE, TEXT, or FILE. -
Description: string
Title:
Description
Maximum Length:255
Description of the catalog attachment. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Path to the folder in which the attached file is uploaded. -
DocumentURL: string
Read Only:
true
Uniform resource locator of the catalog attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Abbreviation that identifies the error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Text of the error message, if any, for the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
Name of the file attached to the item. -
FileUrl: string
Title:
File Url
Uniform resource locator of the attachment file. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date when the user most recently updated the attachment. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
User who most recently updated the attachment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Title: string
Title:
Title
Title of the catalog attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Type of the file content. -
UploadedFileLength: integer
Title:
File Size
Size of the attached file. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the attached file. -
UploadedText: string
Title:
Uploaded Text
Content of the attached text file. -
Uri: string
Title:
Uri
Maximum Length:4000
Uniform resource identifier appended to the base URI derived from the endpoint associated with application identified by the MODULE_ID. -
Url: string
Title:
Url
Maximum Length:4000
Uniform resource locator of the attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
Display 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:
array
Title:
Descriptive Flexfields for Attachments
The Descriptive Flexfields for Attachments resource manages the contextual descriptive flexfields of the category attachments.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The 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 Segment
Maximum Length:150
Descriptive flexfield context name for item category attachments. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Descriptive flexfield context display value for item category attachments. -
AttachedDocumentId: integer
(int64)
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
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.
Nested Schema : itemCategories-DFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
CategoryId: integer
(int64)
Title:
Default Category
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The 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 Name
Maximum Length:2400
Translated name of the category. -
CreationDateTime: string
(date-time)
Read Only:
true
Date and time when the user created the translatable attributes of the category. -
Description: string
Maximum Length:
240
Translated description of the category. -
Language: string
Maximum Length:
4
Language associated with the translated attributes. -
LastUpdateDateTime: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the translatable attributes of the category. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SourceLanguage: string
Maximum Length:
4
Language associated with the translated source category attributes.
Nested Schema : Links
Type:
array
Title:
Links
The 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:
Examples
This example describes how to create categories.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/itemCategories"
Example Request Body
The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.
{ "CategoryName": "Winter_Category", "CategoryCode": " Winter_Category ", "CatalogCode": "Seasonal_Catalog", "translatableAttributes": [ { "CategoryName": "????????????_2", "Description": "?????? _2", "Language": "KO", "SourceLanguage": "KO" } ], "attachments": [ { "DatatypeCode": "WEB_PAGE", "Url": " https://www.example.com/index.html ", "CategoryName": "MISC" } ] }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "CategoryId": 300100184290388, "CategoryCode": " Winter_Category ", "CategoryName": "Winter_Category", "CatalogId": 300100008858583, "CatalogCode": "Seasonal_3", "ParentCategoryCode": null, "Description": null, "StartDate": null, "EndDate": null, "ItemsOnlyFlag": true, "SharedFlag": null, "CreationDateTime": "2019-11-11T05:22:48.023+00:00", "LastUpdateDateTime": "2019-11-11T05:22:49.924+00:00", "attachments": [ { "LastUpdateDate": "2019-11-11T05:22:50.150+00:00", "LastUpdatedBy": "PIMQA", "DatatypeCode": "WEB_PAGE", "FileName": null, "DmFolderPath": "", "Url": "https://www.example.com/index.html", "CategoryName": "MISC", "UserName": null, "Uri": null, "FileUrl": null, "UploadedText": null, "UploadedFileContentType": null, "UploadedFileLength": null, "UploadedFileName": null, "ContentRepositoryFileShared": "false", "Title": "https://www.example.com/index.h", "Description": "", "ErrorStatusCode": null, "ErrorStatusMessage": null, "CreatedBy": "PIMQA", "CreationDate": "2019-11-11T05:22:48.914+00:00", "DocumentURL": "https://www.example.com/index.html", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/itemCategories/00030000000EACED00057708000110F084E1B4540000000EACED00057708000110F07A6CD3D70000000EACED00057708000110F084E1B454/child/attachments/00020000000EACED00057708000110F084E1C00E0000000EACED00057708000110F084E1C00D", "name": "attachments", "kind": "item" }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/itemCategories/00030000000EACED00057708000110F084E1B4540000000EACED00057708000110F07A6CD3D70000000EACED00057708000110F084E1B454/child/attachments/00020000000EACED00057708000110F084E1C00E0000000EACED00057708000110F084E1C00D", "name": "attachments", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/itemCategories/00030000000EACED00057708000110F084E1B4540000000EACED00057708000110F07A6CD3D70000000EACED00057708000110F084E1B454", "name": "itemCategories", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/itemCategories/00030000000EACED00057708000110F084E1B4540000000EACED00057708000110F07A6CD3D70000000EACED00057708000110F084E1B454/child/attachments/00020000000EACED00057708000110F084E1C00E0000000EACED00057708000110F084E1C00D/child/attachmentDFF", "name": "attachmentDFF", "kind": "collection" } ] } ], "translatableAttributes": [ { "CategoryId": 300100184290388, "CategoryName": "???????????? 172", "Description": "?????? 172", "Language": "KO", "SourceLanguage": "KO", "CreationDateTime": "2019-11-11T05:22:48.435+00:00", "LastUpdateDateTime": "2019-11-11T05:22:49.927+00:00", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/itemCategories/00030000000EACED00057708000110F084E1B4540000000EACED00057708000110F07A6CD3D70000000EACED00057708000110F084E1B454/child/translatableAttributes/00020000000EACED00057708000110F084E1B454000000024B4F", "name": "translatableAttributes", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/itemCategories/00030000000EACED00057708000110F084E1B4540000000EACED00057708000110F07A6CD3D70000000EACED00057708000110F084E1B454/child/translatableAttributes/00020000000EACED00057708000110F084E1B454000000024B4F", "name": "translatableAttributes", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/itemCategories/00030000000EACED00057708000110F084E1B4540000000EACED00057708000110F07A6CD3D70000000EACED00057708000110F084E1B454", "name": "itemCategories", "kind": "item" } ] } ], "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/itemCategories/00030000000EACED00057708000110F084E1B4540000000EACED00057708000110F07A6CD3D70000000EACED00057708000110F084E1B454", "name": "itemCategories", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000002770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000017371007E00020000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/itemCategories/00030000000EACED00057708000110F084E1B4540000000EACED00057708000110F07A6CD3D70000000EACED00057708000110F084E1B454", "name": "itemCategories", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/itemCategories/00030000000EACED00057708000110F084E1B4540000000EACED00057708000110F07A6CD3D70000000EACED00057708000110F084E1B454/child/DFF", "name": "DFF", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/itemCategories/00030000000EACED00057708000110F084E1B4540000000EACED00057708000110F07A6CD3D70000000EACED00057708000110F084E1B454/child/attachments", "name": "attachments", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/itemCategories/00030000000EACED00057708000110F084E1B4540000000EACED00057708000110F07A6CD3D70000000EACED00057708000110F084E1B454/child/translatableAttributes", "name": "translatableAttributes", "kind": "collection" } ] }