Catalog Use Cases

I want to	Request Type	Example URL
Retrieve and display details of a requested catalog	GET by ID	{https://MyDomainLoginUrl}/services/apexrest/{namespace}/tmforum/productopenapi/v1/catalog/{ID} NOTE: For invalid catalog ID, you will receive HTTP 404 error.
Based on the provided field values, retrieve and display details of a particular catalog ID.	GET by ID and Fields	{https://MyDomainLoginUrl}/services/apexrest/{namespace}/tmforum/productopenapi/v1/catalog/{ID}?fields=name,id
List all the catalogs present in the system.	GET List	{https://MyDomainLoginUrl}/services/apexrest/{namespace}/tmforum/productopenapi/v1/catalog
List all the catalogs present in the system based on the provided field values.	GET List with Fields	{https://MyDomainLoginUrl}/services/apexrest/{namespace}/tmforum/productopenapi/v1/catalog?name=Cloud Services T
List all the catalogs present in the inventory based on the provided field values and filter applied.	GET List by Fields and Filtering	{https://MyDomainLoginUrl}/services/apexrest/{namespace}/tmforum/productopenapi/v1/catalog?fields=isRoot,name,id&name=Catalog+Wholesale+Business
Limit the number of catalogs to a maximum of specified limit and display results from the page specified by an offset.	GET List by limit and offset	{https://MyDomainLoginUrl}/services/apexrest/{namespace}/tmforum/productopenapi/v1/catalog?lisRoot=true&fields=lifecycleStatus,name&limit=3&offset=2
Create a catalog	POST	{https://MyDomainLoginUrl}/services/apexrest/{namespace}/tmforum/productopenapi/v1/catalog
Update a catalog	PATCH	{https://MyDomainLoginUrl}/services/apexrest/{namespace}/tmforum/productopenapi/v1/catalog/{ID}
Delete a catalog	DELETE	{https://MyDomainLoginUrl}/services/apexrest/{namespace}/tmforum/productopenapi/v1/catalog/{ID}

Consider you want to retrieve details of a catalog from the inventory. For example, catalog ID = 7cc8a363-51ab-2413-7214-6bf24f90e856.

https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/catalog/7cc8a363-51ab-2413-7214-6bf24f90e856

Consider you want to retrieve details of the catalog ID = 7cc8a363-51ab-2413-7214-6bf24f90e856 and get the name and id details in the output.

https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/catalog/7cc8a363-51ab-2413-7214-6bf24f90e856?fields=name,id

Consider you want to retrieve details of all the catalogs in the inventory.

https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/catalog

Consider you want to retrieve all the catalogs by applying the requested fields.

https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/catalog?name=Cloud Services T

Consider you want to retrieve all the catalogs by specified filter.

https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/catalog?fields=isRoot,name,id&name=Catalog+Wholesale+Business

Consider you want to retrieve perform the following.

Limit the number of catalogs to a maximum of specified limit
Display results from the page specified by an offset

https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/catalog?isRoot=true&fields=lifecycleStatus,name&limit=3&offset=2

Consider you want to create a new catalog.

https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/catalog

Consider for the catalog ID: f24eb59b-a466-af2a-4db3-67c87430e8a6, you want to update sub-resource: relatedParty.

https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/catalog/f24eb59b-a466-af2a-4db3-67c87430e8a6

Consider you want to delete a catalog ID: 3830.

https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/catalog/3830