Discoverability

The Lucity REST API provides a method for discoverability of actions on most endpoints (internal REST API only). Each object returned from the REST API includes a DataUrl. This data url is a link to a collection of actions which may be done with the current resource.

discoverability

This is a sample:

discoverability 2

The above 2 action links tell you that you can View the work order (which you obviously already know), and tells you you can Edit the current object and provides the url and verb for each. This is a small portion of the list. Other items which may be included in this list include what children are available on the list and what you can do on the child items:

discoverability 3

It may also include commands like this command available on a work request:

discoverability 4

And the url to use to get attached documents or attach or upload a document:

Discoverability 5

See Also

Special Functions

Getting Record Counts: $count

Getting pick lists: {PropertyName}/ and {PropertyName}/$count

Caching support on lookups

Special lookups

Getting a new empty object: $new

Getting metadata: $fields

Document attachments, uploads, downloads

Working with Existing Filters: $filters and $myfilters

Errors

Commands

Tools

Clearing Cached Data: $cache

Warnings and Conflicts

Getting live updates based on property changes made by an end user

Secure Fields

ObjectCanBeEditied,ObjectCanBeDeleted

SQL Injection Considerations