Category Use Cases

I want to
Request Type
Example URL
Retrieve and display details of a requested category.GET by ID{https://yourInstance.salesforce.com}/services/apexrest/{namespace}/tmforum/productopenapi/v1/category/{ID}

NOTE:
For invalid category ID, you will receive HTTP 404 error.
Based on the provided field values, retrieve and display details of a particular category ID.GET by ID and Fields{https://yourInstance.salesforce.com}/services/apexrest/{namespace}/tmforum/productopenapi/v1/category/{ID}?fields=name,id
List all the categories present in the system.GET List{https://yourInstance.salesforce.com}/services/apexrest/{namespace}/tmforum/productopenapi/v1/category
List all the categories present in the system based on the provided field values.GET List with Fields{https://yourInstance.salesforce.com}/services/apexrest/{namespace}/tmforum/productopenapi/v1/category?name=Postpaid Add On
List all the categories present in the inventory based on the provided field values and filter applied.GET List by Fields and Filtering{https://yourInstance.salesforce.com}/services/apexrest/{namespace}/tmforum/productopenapi/v1/category?fields=lifecycleStatus,lastUpdate
Limit the number of categories to a maximum of specified limit and
display results from the page specified by an offset.		GET List by limit and offset{https://yourInstance.salesforce.com}/services/apexrest/{namespace}/tmforum/productopenapi/v1/category?isRoot=true&fields=lifecycleStatus,name&limit=3&offset=2
Create a category.POST{https://yourInstance.salesforce.com}/services/apexrest/{namespace}/tmforum/productopenapi/v1/category
Update a category.PATCH{https://yourInstance.salesforce.com}/services/apexrest/{namespace}/tmforum/productopenapi/v1/category/{ID}
Delete a category.DELETE{https://yourInstance.salesforce.com}/services/apexrest/{namespace}/tmforum/productopenapi/v1/category/{ID}

Consider you want to retrieve details of a category from the inventory. For example, category ID = 432b3763-2233-65cd-8ba3-a67a035aab74.

https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/category/432b3763-2233-65cd-8ba3-a67a035aab74

Consider you want to retrieve details of the category 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/category/7cc8a363-51ab-2413-7214-6bf24f90e856?fields=name,id

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

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

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/category?name=Postpaid Add On

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

https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/category?id=ad2afce3-2690-10f8-f765-16e0a0bb9bbd&fields=lifecycleStatus,lastUpdate

Consider you want to retrieve perform the following.

  • Limit the number of categories 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/category?isRoot=true&fields=lifecycleStatus,name&limit=3&offset=2

Consider you want to create a new category.

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

Consider for the category ID: 432b3763-2233-65cd-8ba3-a67a035aab74, you want to update sub-resources: subCategory / productOffering.

https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/category/432b3763-2233-65cd-8ba3-a67a035aab74

Consider you want to delete a category ID: 3830.

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