Query Context Tags Action

Query the tag values from an instance that are associated with a context definition.

This action is available in API version 63.0 and later.

Special Access Rules

Available in Developer, Enterprise, Professional, and Unlimited editions for Industries clouds where Context Service is enabled.

Supported REST HTTP Methods

URI: /services/data/vXX.X/actions/standard/queryContextTags

Where XX.X is the latest API version.

Formats: JSON, XML

HTTP Methods: POST

Authentication: Authorization: Bearer TOKEN

Where TOKEN is a variable.

Inputs

Input	Type	Description
`contextId`	string	Required. The ID of the context instance.
`tagsList`	string	Required. A collection of tags to be queried.

Outputs

Output	Type	Description
`queryResult`	string	The output of the queried context instance.

Example

POST

This sample request is for the Query Context Tags action.

1{
2  "inputs": [
3    {
4      "contextId": "0000000a07da09100251752497651022c35b6150a4d04cd6a84bf1a0439cc609",
5      "tagList": [
6        "Account_Name",
7        "Contact_LastName"
8      ]
9    }
10  ]
11}

This sample response is for the Query Context Tags action.

1{
2  "actionName": "queryContextTags",
3  "errors": null,
4  "invocationId": null,
5  "isSuccess": true,
6  "outputValues": {
7    "queryResult": {
8      "Contact_LastName": [
9        {
10          "tagValue": "Miller",
11          "dataPath": [
12            "0000000a07da09100251752497651022c35b6150a4d04cd6a84bf1a0439cc609",
13            "account1",
14            "contact1"
15          ],
16          "eTag": "fba12e2955bf4a46354fee73ee8b238c",
17          "weakEtag": 0
18        }
19      ],
20      "Account_Name": [
21        {
22          "tagValue": "AcmeFlow",
23          "dataPath": [
24            "0000000a07da09100251752497651022c35b6150a4d04cd6a84bf1a0439cc609",
25            "account1"
26          ],
27          "eTag": "fa0867f98939f191957687c1456715f7",
28          "weakEtag": 0
29        }
30      ]
31    }
32  },
33  "sortOrder": -1,
34  "version": 1
35}