{ 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:

Nameurimethods
{ routes.name }{ routes.uri }{ routes.methods.join(', ') }

Fields

NameQuery Parameter
{ field.Field }?{ field.filter }

Searchable Fields help_outline

Name
{ searchableField }

Embedded Objects help_outline

{ embedded.name } ({ embedded.type })

Resource Documentation:{ embedded.docs_editor_href }
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 ParameterFunction
pagePage of result Set
per_pageItems per page of support set
order_fieldsComma seperated list of fields to order by
order_dirsComma seperated list of ASC or DESC, which indicates the ordering for the corresponding 'order_field' option

API Hooks help_outline

Hookprocess(...) arguments help_outline
{ availableHook.operation } { processArg }: { processArg }

Cannot find anything related to "{ keyword }"