Retrieving text State from ServiceNow REST API

Question

I'm building a fairly simple REST app for ServiceNow. Using the REST API Explorer (great tool!) and some examples on here I've been able to connect and raise Incident records with all the field information I need.

The only thing I can't seem to wrap my head around is how to pick up the text label of an Incident State - I can get the integer from the Incident record and I understand there is a relationship set up within the Dictionary between each integer and a corresponding label. Eg. Incident State=1, Label is "New"

Maybe I'm wrong, but I would expect I can look up another table via REST, pull out the integers and retrieve my text statuses? I've tried accessing the Dictionary table in the API explorer but this doesn't go far enough...any help out there please?

My goal for this integration is to raise an incident or request, and then when required report back the status of said record - been doing my head in for days...

score 6 · Accepted Answer · answered Apr 15 '16 at 19:56

What you're looking for is a display value. You can set a query parameter using REST API Explorer named sysparm_display_value.

Value options are:

true returns display values for all of the fields.
false returns actual values from the database. If a value is not specified, this parameter defaults to false.
all returns both actual and display values.

From the wiki: here

Using the value all, this is what the payload returns for incident_state:

"incident_state": { "display_value": "On Hold", "value": "3" }

score 1 · Answer 2 · answered Jul 11 '20 at 10:11

The following REST API call will fetch the Label of any State value,

https://<SERVICENOW_DOMAIN_NAME>/api/now/table/sys_choice?sysparm_query=name=<TABLE_NAME>^element=state^value=<STATE_VALUE>

Replace <SERVICENOW_DOMAIN_NAME>, <TABLE_NAME> and <STATE_VALUE> with appropriate values. Here's an example request and response,

Here's a C# method that will return the Label value of a status,

public String getStateLabel(String tableName, String stateValue)
    {
        String URL = "https://demohost/api/now/table/sys_choice?sysparm_query=name=" + tableName + "^element=state^value=" + stateValue;
        var client = new WebClient();
        client.Headers.Add("user-agent", "Mozilla/5.0 (Windows NT 6.1; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.110 Safari/537.36");
        client.Credentials = new NetworkCredential("demouser", "demopassword");
        var response = client.DownloadString(URL);
        dynamic jsonMessage = Newtonsoft.Json.JsonConvert.DeserializeObject(response);
        return jsonMessage.result[0].label;
    }

Retrieving text State from ServiceNow REST API

2 Answers2