Create or update an array of catagories
https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/categories
Request
There are no request parameters for this operation.
- application/json
array
1
50
-
Array of:
CategoryOracle
Title:
CategoryOracle
CategoryOracle
-
object
Category
Title:
Category
Discriminator:{ "propertyName":"@type", "mapping":{ "Category":"#/components/schemas/Category", "CategoryOracle":"#/components/schemas/CategoryOracle" } }
-
object
CategoryOracle-allOf[1]
object
Category
Discriminator Values
Show Source-
@baseType: string
the base class type of the category
-
@schemaLocation: string
link to the schema describing this category
-
@type: string
the class type of the Category
-
description: string
Description of the category
-
href: string
Reference of the catalog
-
id: string
Maximum Length:
30
Unique identifier of the category -
isRoot: boolean
If true, this Boolean indicates that the category is a root of categories
-
lastUpdate: string
(date-time)
Date and time of the last update
-
lifecycleStatus: string
Used to indicate the current lifecycle status
-
name(required): string
Name of the category
-
parentId: string
Unique identifier of the parent category
-
productOffering: array
productOffering
-
subCategory: array
subCategory
-
validFor: object
TimePeriod
Title:
TimePeriod
The period for which the productOffering is valid -
version: string
Category version
object
-
applicationName: string
name of the external application
-
created: string
(date-time)
Date and time of the creation
-
createdBy: string
name of the person who created item
-
externalId: string
id of the external application
-
lastUpdatedBy: string
name of the person who updated item
-
project: object
ProjectRef
Title:
ProjectRef
Project Reference -
versionState: number
Version state of the category
object
ProjectRef
-
href: string
Unique reference of the project
-
id(required): string
Unique identifier of the project
-
name: string
Name of the project
-
version: string
Version of the project
Response
- application/json
200 Response
CategoryOracle
-
object
Category
Title:
Category
Discriminator:{ "propertyName":"@type", "mapping":{ "Category":"#/components/schemas/Category", "CategoryOracle":"#/components/schemas/CategoryOracle" } }
-
object
CategoryOracle-allOf[1]
object
Category
Discriminator Values
Show Source-
@baseType: string
the base class type of the category
-
@schemaLocation: string
link to the schema describing this category
-
@type: string
the class type of the Category
-
description: string
Description of the category
-
href: string
Reference of the catalog
-
id: string
Maximum Length:
30
Unique identifier of the category -
isRoot: boolean
If true, this Boolean indicates that the category is a root of categories
-
lastUpdate: string
(date-time)
Date and time of the last update
-
lifecycleStatus: string
Used to indicate the current lifecycle status
-
name(required): string
Name of the category
-
parentId: string
Unique identifier of the parent category
-
productOffering: array
productOffering
-
subCategory: array
subCategory
-
validFor: object
TimePeriod
Title:
TimePeriod
The period for which the productOffering is valid -
version: string
Category version
object
-
applicationName: string
name of the external application
-
created: string
(date-time)
Date and time of the creation
-
createdBy: string
name of the person who created item
-
externalId: string
id of the external application
-
lastUpdatedBy: string
name of the person who updated item
-
project: object
ProjectRef
Title:
ProjectRef
Project Reference -
versionState: number
Version state of the category
object
ProjectRef
-
href: string
Unique reference of the project
-
id(required): string
Unique identifier of the project
-
name: string
Name of the project
-
version: string
Version of the project
400 Response
array
-
Array of:
object Discriminator: @type
Discriminator:
{ "propertyName":"@type", "mapping":{ "Error":"#/components/schemas/Error", "BulkError":"#/components/schemas/BulkError" } }
401 Response
object
Error
-
@schemaLocation: string
It provides a link to the schema describing a REST resource.
-
@type: string
The class type of a REST resource.
-
code(required): string
Application related code (as defined in the API or from a common list)
-
message: string
Text that provide more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
Text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
url pointing to documentation describing the error
-
status: string
http error code extension like 400-2
404 Response
object
Error
-
@schemaLocation: string
It provides a link to the schema describing a REST resource.
-
@type: string
The class type of a REST resource.
-
code(required): string
Application related code (as defined in the API or from a common list)
-
message: string
Text that provide more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
Text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
url pointing to documentation describing the error
-
status: string
http error code extension like 400-2
405 Response
object
Error
-
@schemaLocation: string
It provides a link to the schema describing a REST resource.
-
@type: string
The class type of a REST resource.
-
code(required): string
Application related code (as defined in the API or from a common list)
-
message: string
Text that provide more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
Text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
url pointing to documentation describing the error
-
status: string
http error code extension like 400-2
500 Response
object
Error
-
@schemaLocation: string
It provides a link to the schema describing a REST resource.
-
@type: string
The class type of a REST resource.
-
code(required): string
Application related code (as defined in the API or from a common list)
-
message: string
Text that provide more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
Text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
url pointing to documentation describing the error
-
status: string
http error code extension like 400-2
Examples
The following example shows how to create or update an array of catagories by submitting a put request on the REST resource using cURL.
cURL Command
curl -u username:password -X PUT https://{FusionAppsHost}//crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/categories -H 'Content-Type: application/json' -D @put_categories.json | json_pp
Example of Request Body
The following shows an example of the request body in JSON format.
[ { "id": "SwissCommCategory001", "name": "SwissCommCategory001", "description": "Description of Swisss Category description", "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/category/SwissCommCategory", "version": "1.0", "lifecycleStatus": "In design", "created": "2021-07-03T09:40:43.000Z", "createdBy": "booth", "lastUpdate": "2021-07-03T09:40:46.657Z", "lastUpdatedBy": "booth", "@type": "CategoryOracle", "@baseType": "Category", "validFor": { "startDateTime": "2020-08-07T10:00:38.028Z", "endDateTime": "2021-08-03T10:00:38.029Z" }, "project": { "id": "BulkDocProject", "name": "Bulk Doc Project", "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/project/IntegrationProject" } }, { "id": "SwissCommCategory002", "name": "SwissCommCategory002", "description": "Description of Swisss Category description", "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/category/SwissCommCategory", "version": "1.0", "lifecycleStatus": "In design", "created": "2021-07-03T09:40:43.000Z", "createdBy": "booth", "lastUpdate": "2021-07-03T09:40:46.657Z", "lastUpdatedBy": "booth", "@type": "CategoryOracle", "@baseType": "Category", "validFor": { "startDateTime": "2020-08-07T10:00:38.028Z", "endDateTime": "2021-08-03T10:00:38.029Z" }, "project": { "id": "BulkDocProject", "name": "Bulk Doc Project", "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/project/IntegrationProject" } } ]
Example of Response Body
The following shows an example of the response body in JSON format.
[ { "id": "SwissCommCategory001", "name": "SwissCommCategory001", "description": "Description of Swisss Category description", "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/categories/SwissCommCategory001", "version": "1.0", "lifecycleStatus": "In design", "@type": "CategoryOracle", "@baseType": "Category", "validFor": { "startDateTime": "2020-08-07T10:00:38.028Z", "endDateTime": "2021-08-03T10:00:38.029Z" }, "project": { "id": "BulkDocProject", "name": "Bulk Doc Project", "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/project/BulkDocProject" } }, { "id": "SwissCommCategory002", "name": "SwissCommCategory002", "description": "Description of Swisss Category description", "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/categories/SwissCommCategory002", "version": "1.0", "lifecycleStatus": "In design", "@type": "CategoryOracle", "@baseType": "Category", "validFor": { "startDateTime": "2020-08-07T10:00:38.028Z", "endDateTime": "2021-08-03T10:00:38.029Z" }, "project": { "id": "BulkDocProject", "name": "Bulk Doc Project", "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/project/BulkDocProject" } } ]