Update a catalog
patch
https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/catalog/{id}
Request
Path Parameters
-
id(required): string
The unique identifier of the resource item.
Supported Media Types
- application/json
Nested Schema : Catalog
Type:
objectTitle:
CatalogDiscriminator: @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:
30Unique 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:
TimePeriodThe 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:
ProjectRefProject Reference -
versionState: number
Version state of the catalog
Nested Schema : ProjectRef
Type:
objectTitle:
ProjectRefProject 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
OK
Nested Schema : Catalog
Type:
objectTitle:
CatalogDiscriminator: @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:
30Unique 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:
TimePeriodThe 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:
ProjectRefProject Reference -
versionState: number
Version state of the catalog
Nested Schema : ProjectRef
Type:
objectTitle:
ProjectRefProject 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 : Error
Type:
objectTitle:
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
401 Response
Your request isn't authorized. The authentication credentials included with this request are missing or invalid.
Root Schema : Error
Type:
objectTitle:
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:
objectTitle:
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:
objectTitle:
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:
objectTitle:
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 update a catalog by submitting a PATCH request on the REST resource using cURL.
cURL Command
curl -u username:password -X PATCH https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/catalog/ConsumerCatalog -H 'Content-Type: application/json' -D @update_catalog.json | json_pp
Example of Request Body
The following example shows the contents of the request body in JSON format.
{
"id": "ConsumerCatalog",
"name": "Consumer Catalog",
"description": "ConsumerCatalog Catalog Description for product offerings",
"@baseType": "Catalog",
"@type": "CatalogOracle",
"version": "2.0",
"lifecycleStatus": "In design",
"validFor": {
"startDateTime": "2020-08-02T10:00:38.028Z",
"endDateTime": "2021-08-03T10:00:38.029Z"
},
"project": {
"id": "SpringProject",
"name": "SpringProject"
}
}Example of Response Body
The
following example shows the contents of the request body in JSON format.
{
"id": "ConsumerCatalog",
"name": "Consumer Catalog",
"description": "ConsumerCatalog Catalog Description for product offerings",
"@baseType": "Catalog",
"@type": "CatalogOracle",
"version": "2.0",
"lifecycleStatus": "In design",
"validFor": {
"startDateTime": "2020-08-02T10:00:38.028Z",
"endDateTime": "2021-08-03T10:00:38.029Z"
},
"project": {
"id": "SpringProject",
"name": "SpringProject"
},
"created": "2020-08-21T05:55:08.000Z",
"createdBy": "anonymous",
"lastUpdate": "2020-08-21T05:55:08.000Z",
"lastUpdatedBy": "anonymous",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/catalog/ConsumerCatalog"
}