...
| 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 attribute of the resource and relates to another resource. This relationship can be either one-to-one or one-to-many (presented represented 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. |
...
A table of resources, with its corresponding URL templates. The items in this table are primarily comprised of linked resources that are referenced in the resource object, or where the primary resource is referenced in additional resources.
Errors
A table of error codes that may be encountered. The primary field that is affected by the error is listed as well as a description of the conditions that exist on the field when setting it's value.
Formats
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: string, number, boolean and null. Additionally, any string base type may be followed by a length option: i.e. string(<5) This denotes that length of the value must be less than 5 characters. Similarly a format of "string(>5)" would denote that the value of the attribute must be greater than 5 characters.
...