Tags and descriptions

If you have lots of resources, you can filter these to include only the resources that match specific criteria. The types of resources that you can list include ApplicationGroups, Applications, Flows, Partners, Products, UnmanagedProducts, and CommunicatonProfiles. For information on adding custom attributes, see Use custom attributes.

Update tags on resources

You can use the tags resource to update tags on multiple objects that are of the same type.

PUT /api/v2/tags

{

  "ids": ["a2b4e9a8-e45f-42b0-9e3f-c6a3ad29b504",

  "547ea5b4-f228-44ef-a4b6-0ae01040a921"],

  "type": "Applications",

  "tags": ["t2","t3"]

}

Retrieve resources using tags

You can filter Application Groups, Applications, Flows, Products, Partners, and Unmanaged Products using tags:

GET /api/v2/resource?tags=new_client

Or

GET /api/v2/resource?tags=%new%

Retrieve product communication profiles using tags

You can then use tags as a means of searching for product communication profiles based on certain criteria.

Example

If a given product has the following communication profiles:

  • com_profile_1 has tags=[tag1,tag2]
  • com_profile_2 has tags=[tag3,tag1]

In the following request, the GET returns both communication profiles:

GET /api/v2/products/productid/communicationprofiles?tags=tag1

While in this example the request returns only com_profile_1:

GET /api/v2/products/productid/communicationprofiles?tags=tag1&tags=tag2

Retrieve product communication profiles using a description

You can also retrieve product communication profiles that have specific content in the description field. For example, to return all communication profiles that are described as a new_client:

GET /api/v2/products/productid/communicationprofiles?description=new_client

Or, you can perform a search among the communication profile descriptions based on a string:

GET /api/v2/products/productid/communicationprofiles?description=%new%

 

Central Governance | Document Directory

Related Links