Resources are the objects that Actionstep has made available to API clients. Each resource page defines properties and fields available to for that resource. Below is a description of each section common to all of the properties defined in each pageresource pages.
Resource Location
The resource path to be appended to the base endpoint in order to act on this resource. For example:
...
The following table is a list of formats and format options that are used in this documentation to describe the form a value should take when creating and updating resources. Each format has a base type of either: string, number, boolean and or null. Additionally, any the string base type may be followed by supports a length option: i.e. . For example, "string(<55) This " denotes that the max length of the value must be less than is 5 characters. Similarly a format of "string(>5)" would denote that the value of the attribute must be greater than 5 characters.
| Format | Base Type | Example | Notes |
|---|---|---|---|
| timestamp | string | "2014-12-28T17:23:14+12:00" | |
| decimal(precision,length) | number | 12.6 | Custom decimal number that doesn't conform to our other specified decimal formats. |
| currency | number | 13.10 | Decimal number with a set precision of 2 and a set length of 10. |
| time | number | 15.82 | Decimal number with a set precision of 2. |
| collection | string | "[1,2,3]" |
...