Create or update an array of catalogs
put
https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/catalogs
Creates or updates the supplied array of catalogs in a single request.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
arrayMinimum Number of Items:
1Maximum Number of Items:
50The catalogs resource.
Show Source
-
Array of:
CatalogOracle
Title:
CatalogOracle
Nested Schema : Catalog
Type:
objectTitle:
CatalogDiscriminator: @type
Discriminator Values
The catalog resource.
Show Source
-
@baseType: string
Indicates the base class type of this REST resource.
-
@schemaLocation: string
The URI of the schema that defines the catalog.
-
@type(required): string
Indicates the (class) type of catalog. For entity catalogs, this will be 'EntityCatalog'.
-
catalogType: string
The type or classification of the catalog.
-
category: array
category
A list of categories associated with the catalog.
-
description: string
The description of this catalog.
-
href: string
The hyperlink reference to the catalog.
-
id: string
Maximum Length:
30The ID of the catalog. -
lastUpdate: string
(date-time)
The date and time when the catalog was last updated.
-
lifecycleStatus: string
The status of the catalog.
-
name(required): string
The name of the catalog.
- relatedParty: array relatedParty
-
validFor: object
TimePeriod
Title:
TimePeriodThe period for which the productOffering is valid. -
version: string
The catalog version.
Nested Schema : type
Type:
Show Source
object-
applicationName: string
The name of the application associated with the catalog.
-
created: string
(date-time)
The date and time of the creation.
-
createdBy: string
The name of the person who created item.
-
externalId: string
The ID of the external associated with the catalog.
-
lastUpdatedBy: string
The name of the person who updated item.
-
project: object
ProjectRef
Title:
ProjectRefThe project reference resource. -
versionState: number
The version state of the catalog.
Nested Schema : ProjectRef
Type:
objectTitle:
ProjectRefThe project reference resource.
Show Source
-
href: string
The hyperlink reference to the project reference.
-
id(required): string
The ID of the project reference.
-
name: string
The name of the project reference.
-
version: string
The version of the project.
Response
Supported Media Types
- application/json
200 Response
The list of catalogs was created or updated successfully.
Nested Schema : Catalog
Type:
objectTitle:
CatalogDiscriminator: @type
Discriminator Values
The catalog resource.
Show Source
-
@baseType: string
Indicates the base class type of this REST resource.
-
@schemaLocation: string
The URI of the schema that defines the catalog.
-
@type(required): string
Indicates the (class) type of catalog. For entity catalogs, this will be 'EntityCatalog'.
-
catalogType: string
The type or classification of the catalog.
-
category: array
category
A list of categories associated with the catalog.
-
description: string
The description of this catalog.
-
href: string
The hyperlink reference to the catalog.
-
id: string
Maximum Length:
30The ID of the catalog. -
lastUpdate: string
(date-time)
The date and time when the catalog was last updated.
-
lifecycleStatus: string
The status of the catalog.
-
name(required): string
The name of the catalog.
- relatedParty: array relatedParty
-
validFor: object
TimePeriod
Title:
TimePeriodThe period for which the productOffering is valid. -
version: string
The catalog version.
Nested Schema : type
Type:
Show Source
object-
applicationName: string
The name of the application associated with the catalog.
-
created: string
(date-time)
The date and time of the creation.
-
createdBy: string
The name of the person who created item.
-
externalId: string
The ID of the external associated with the catalog.
-
lastUpdatedBy: string
The name of the person who updated item.
-
project: object
ProjectRef
Title:
ProjectRefThe project reference resource. -
versionState: number
The version state of the catalog.
Nested Schema : ProjectRef
Type:
objectTitle:
ProjectRefThe project reference resource.
Show Source
-
href: string
The hyperlink reference to the project reference.
-
id(required): string
The ID of the project reference.
-
name: string
The name of the project reference.
-
version: string
The 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:
objectTitle:
ErrorThe error resource.
Show Source
-
@schemaLocation: string
The URI of the schema that defines the error.
-
@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
The text that provides more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
The text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
The URL pointing to documentation describing the error.
-
status: string
The status of the error.
404 Response
The resource with the specified URI couldn't be found.
Root Schema : Error
Type:
objectTitle:
ErrorThe error resource.
Show Source
-
@schemaLocation: string
The URI of the schema that defines the error.
-
@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
The text that provides more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
The text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
The URL pointing to documentation describing the error.
-
status: string
The status of the error.
405 Response
HTTP action specified in the request (DELETE, GET, POST, PUT) isn't supported for this request URI.
Root Schema : Error
Type:
objectTitle:
ErrorThe error resource.
Show Source
-
@schemaLocation: string
The URI of the schema that defines the error.
-
@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
The text that provides more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
The text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
The URL pointing to documentation describing the error.
-
status: string
The status of the error.
500 Response
The server encountered something unexpected that prevented it from completing the request.
Root Schema : Error
Type:
objectTitle:
ErrorThe error resource.
Show Source
-
@schemaLocation: string
The URI of the schema that defines the error.
-
@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
The text that provides more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
The text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
The URL pointing to documentation describing the error.
-
status: string
The status of the error.
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"
}
]
}
]