API Labeling
Select fields to display to users from your API response (called Label API response in Queries).
Setup Identifier & Description
Select an Identifier & Description from the dropdowns. These 2 values summarize & help users understand your data.
![api labeling id description api labeling id description](/static/8d43b0b98413d9c9151773774de864e2/c6bbc/api-labeling-id-description.png)
Select Additional Fields
Optionally, select additional fields to display. Moveworks learns your API & allows you to select only relevant fields. These fields will display as additional information with your identifier & description.
![api labeling additional fields api labeling additional fields](/static/a04f49d392b0d561f2999acd4e0e67d6/c6bbc/api-labeling-additional-fields.png)
Labels are generated automatically
👉 We understand your data & default assign a human friendly label in Start case.
Maximum # of Records in a Query
👉 We support displaying a maximum of 30 records for a single query. These are the first 30 records from your API response.
Advanced Mode
Use theSWITCH TO ADVANCED MODE
toggle in 3 situations:
![advanced mode advanced mode](/static/730807f3a2b52b385322b85996b7b12e/c6bbc/advanced_mode.png)
1. API response is too large
If your fields aren't displayed in the Table View UI, use dot-walking in Advanced mode to specify your fields manually.
2. Field name contains a dot (.
)
To display a field name that contains a dot, escape the dot with a backslash (\
). Refer to escaping dots from names using a dot-walk.3. Display a specific item from list
To display only a specific item from a list in your API:
- Use the
.0
or.N
notation to reference the specific item. - Add your fields from the item as identifier, description & additional fields (optional).
![dot walking dot walking](/static/3191719c1ad017ee3e43d2a6fac7822c/c6bbc/dot-walking.png)
User Experience
Generally our Query results will have two cards, one for a list of records (List View), and one for a single record (Details View). Here's how your fields are displayed:
List View Card
![8 list view 8 list view](/static/238c6ce1e0944bf089f75e6df26df0ac/c6bbc/8.list-view.png)
Details View Card
![9 detail view 9 detail view](/static/1572ac97c7679041fbafdce9ff1e840f/c6bbc/9.detail-view.png)
When labeling your API fields, you can refer to the following examples:
Field Type | What to use | Examples |
---|---|---|
Identifier (required) | A concise & unique value | Record ID (Employee ID, PO #, etc.) |
Description (required) | Important secondary info | Record Title (Employee name, PO title, etc.) |
Additional Fields (optional, unlimited) | Details needed by employees to get full context on the record | More Record Information (Employee start date, PO delivery date, etc.) |