{ article.Name }
({ article.docData.ResourceType }) help_outline
REST Resource for managing { article.Name } Objects
API Routes
The following HTTP methods and URIs are respected by this resource:
| Name | uri | methods |
|---|---|---|
| { routes.name } | { routes.uri } | { routes.methods.join(', ') } |
Fields
| Name | Query Parameter |
|---|---|
| { field.Field } | ?{ field.filter } |
Searchable Fields help_outline
| Name |
|---|
| { searchableField } |
Embedded Objects help_outline
{ embedded.name } ({ embedded.type })
| Resource Documentation: | |
| JSON path help_outline | { embedded.path } |
| Hydration Key help_outline | { embedded.populate_related } |
| Related Filter Query Template: help_outline | ?{ embedded.related_filter } |
| Relationship Type: | Collection ({ embedded.collectionType }) 1:1 |
{ article.Name } - JSON Example
Pagination And Ordering Parameters help_outline
| Query Parameter | Function |
|---|---|
| page | Page of result Set |
| per_page | Items per page of support set |
| order_fields | Comma seperated list of fields to order by |
| order_dirs | Comma seperated list of ASC or DESC, which indicates the ordering for the corresponding 'order_field' option |
API Hooks help_outline
| Hook | process(...) arguments help_outline |
|---|---|
| { availableHook.operation } | { processArg }: { processArg } |