Dot-walking Reference

Use dot-walking to reference specific objects or fields from your API's JSON response. Moveworks supports the following dot-walk notations:

1. Simple dot-walking (.)

Using a dot after the object name allows selecting an indexed field or object. For example, suppose you have an object called data:

Copy
Copied
"data": {
    "name": "Tom"
}
To access Tom, you would use data.name.

2. Dot-walking to a specific item from a list (.N)

Using .0 or .N notation allows referencing a specific item from a list.
  • For example, suppose you had an object called meetings:
Copy
Copied
{
  "meetings": [
    {
      "attendee_list": [
        {
          "name": "John Doe"
        },
        {
          "name": "Jim Jones"
        }
      ]
    },
    {
      "attendee_list": [
        {
          "name": "Jane Doe"
        }
      ]
    }
  ],
  "total": 2
}
To access only Jim Jones, you would use meetings.0.attendee_list.1.name. In this example:
  • meetings.0 accesses the first meeting &
  • attendee_list.1 accesses the second attendee.

3. Escape dots from object & field names (\)

If your object or field contains a period in the name, remember to escape it with a backslash (\).
  • For example, for the following object:
Copy
Copied
{
"result" : {
  "model.name": "Honda"
 }
}
To access the model's name, your would use model\.name.