Create or update an array of catalog
put
https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/catalogs
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
array
Minimum Number of Items:
1
Maximum Number of Items:
Show Source
50
-
Array of:
CatalogOracle
Title:
CatalogOracle
Nested Schema : Catalog
Type:
object
Title:
Catalog
Discriminator: @type
Discriminator Values
Show Source-
@baseType: string
Indicates the base (class) type of this REST resource
-
@schemaLocation: string
This field provides a link to the schema describing this REST resource
-
@type: string
Indicates the (class) type of catalog. For entity catalogs, this will be 'EntityCatalog'.
-
catalogType: string
It indicates the type of catalog
-
category: array
category
-
description: string
Description of this catalog
-
href: string
Unique reference of the catalog
-
id: string
Maximum Length:
30
Unique identifier of the Catalog -
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 catalog
- relatedParty: array relatedParty
-
validFor: object
TimePeriod
Title:
TimePeriod
The period for which the productOffering is valid -
version: string
Catalog version
Nested Schema : type
Type:
Show Source
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 catalog
Nested Schema : ProjectRef
Type:
object
Title:
ProjectRef
Project Reference
Show Source
-
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
Supported Media Types
- application/json
200 Response
Your request is successful and the resources have been created or updated.
Nested Schema : Catalog
Type:
object
Title:
Catalog
Discriminator: @type
Discriminator Values
Show Source-
@baseType: string
Indicates the base (class) type of this REST resource
-
@schemaLocation: string
This field provides a link to the schema describing this REST resource
-
@type: string
Indicates the (class) type of catalog. For entity catalogs, this will be 'EntityCatalog'.
-
catalogType: string
It indicates the type of catalog
-
category: array
category
-
description: string
Description of this catalog
-
href: string
Unique reference of the catalog
-
id: string
Maximum Length:
30
Unique identifier of the Catalog -
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 catalog
- relatedParty: array relatedParty
-
validFor: object
TimePeriod
Title:
TimePeriod
The period for which the productOffering is valid -
version: string
Catalog version
Nested Schema : type
Type:
Show Source
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 catalog
Nested Schema : ProjectRef
Type:
object
Title:
ProjectRef
Project Reference
Show Source
-
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
Your request couldn't be processed because it contains missing or invalid information, such as a validation error on an input field, a missing required value, and so forth.
Root Schema : schema
Type:
Show Source
array
-
Array of:
object Discriminator: @type
Discriminator:
{ "propertyName":"@type", "mapping":{ "Error":"#/components/schemas/Error", "BulkError":"#/components/schemas/BulkError" } }
401 Response
Your request isn't authorized. The authentication credentials included with this request are missing or invalid.
Root Schema : Error
Type:
object
Title:
Show Source
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
Your request includes a resource URI that doesn't exist.
Root Schema : Error
Type:
object
Title:
Show Source
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
HTTP action specified in the request (DELETE, GET, POST, PUT) isn't supported for this request URI.
Root Schema : Error
Type:
object
Title:
Show Source
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
The server encountered something unexpected that prevented it from completing the request.
Root Schema : Error
Type:
object
Title:
Show Source
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 catalog 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/catalogs -H 'Content-Type: application/json' -D @put_catalogs.json | json_pp
Example of Request Body
The following shows an example of the request body in JSON format.
[ { "id": "CommunicationCatalog001", "name": "CommunicationCatalog 001", "description": "CommunicationCatalog Description", "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/catalog/CommunicationCatalog", "version": "1.0", "lifecycleStatus": "In design", "created": "2021-07-03T09:43:37.000Z", "createdBy": "booth", "lastUpdate": "2021-07-03T09:43:37.231Z", "lastUpdatedBy": "booth", "@type": "CatalogOracle", "@baseType": "Catalog", "validFor": { "startDateTime": "2020-08-02T10: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" }, "category": [ { "id": "SwissCommCategory001", "name": "SwissCommCategory 001", "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/category/SwissCommCategory", "version": "1.0", "@referredType": "CategoryOracle" } ] }, { "id": "CommunicationCatalog002", "name": "CommunicationCatalog 002", "description": "CommunicationCatalog Description", "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/catalog/CommunicationCatalog", "version": "1.0", "lifecycleStatus": "In design", "created": "2021-07-03T09:43:37.000Z", "createdBy": "booth", "lastUpdate": "2021-07-03T09:43:37.231Z", "lastUpdatedBy": "booth", "@type": "CatalogOracle", "@baseType": "Catalog", "validFor": { "startDateTime": "2020-08-02T10: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" }, "category": [ { "id": "SwissCommCategory002", "name": "SwissCommCategory 002", "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/category/SwissCommCategory", "version": "1.0", "@referredType": "CategoryOracle" } ] } ]
Example of Response Body
The following shows an example of the response body in JSON format.
[ { "id": "CommunicationCatalog001", "name": "CommunicationCatalog 001", "description": "CommunicationCatalog Description", "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/catalogs/CommunicationCatalog001", "version": "1.0", "lifecycleStatus": "In design", "@type": "CatalogOracle", "@baseType": "Catalog", "validFor": { "startDateTime": "2020-08-02T10: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" }, "category": [ { "id": "SwissCommCategory001", "name": "SwissCommCategory001", "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/category/SwissCommCategory001", "version": "1.0", "@referredType": "CategoryOracle" } ] }, { "id": "CommunicationCatalog002", "name": "CommunicationCatalog 002", "description": "CommunicationCatalog Description", "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/catalogs/CommunicationCatalog002", "version": "1.0", "lifecycleStatus": "In design", "@type": "CatalogOracle", "@baseType": "Catalog", "validFor": { "startDateTime": "2020-08-02T10: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" }, "category": [ { "id": "SwissCommCategory002", "name": "SwissCommCategory002", "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/category/SwissCommCategory002", "version": "1.0", "@referredType": "CategoryOracle" } ] } ]