Resources are the objects that Actionstep has made available to API clients. Each resource page defines properties the and fields available to that resource. Below is a description of the properties defined in each page.
Resource Location
The resource identifier path to be appended to the base endpoint in order to act on this resource. For example:
...
Page Size & Max Page Size
Most resources may return multiple instances. In this case the results will be exist as collections. As such, collections greater than the default or requested page size will be returned paged. Each resource defines the default page size and a max page size. The default page size cannot be adjusted but a custom page size can be requested as long as it doesn't exceed the max page size, which also cannot be adjusted. These The default values are set in relation to the size of the resource objects requested.
...
| Field | The attribute name |
|---|---|
| Description | A short description of the attribute |
| Format | The format that Actionstep requires the attribute value to be in when creating or updating resources. See Formats. |
| Required | Indicates if the attribute is required when creating or updating a recourse. |
| Field Type | Indicates the type of attribute when requesting a resource. An attribute with the type "default" will be returned automatically with a resource request; whereas, an attributed with the type "additional" must be requested specifically if it is to be returned as part of the resource. A "link" type indicates that the attribute is found in the links object attribute of the resource and relates to another resource. This relationship can be either one-to-one or one-to-many (presented by example values of "1" and "[1,2,3]" respectively). |
| Notes | Helpful information - particularly in regard to required logic and constraints when creating or updating resources. |
...
| 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. |
| collection | string | "[1,2,3]" |