Fields

You can control which fields should be included in the documents returned by a query. Provide the field names with the fields parameter.

The fields parameter works for single documents as well as for list endpoints.

Control which fields are included for a response

GET https://api.cmft.io/v1/<repoName>/<endpoint>?fields=fields|meta|includes(<field1>,<field2>)

Path Parameters

Name
Type
Description

repoName

string

The API identifier of the repository

endpoint

string

The endpoint you'd like to request

fields

string

Provide the field API IDs you'd like to be included in a document

// Query with 'title' as field
{
  "fields": {
    "title": "Roses are red"
  },
  "meta": {
    "id": "314159265358979323",
    "contentType": "poem",
    "repository": "314159265358979323",
    "revision": 1,
    "tags": [],
    "createdAt": "2018-01-01T00:00:00.000Z",
    "updatedAt": "2018-01-01T00:00:00.000Z"
  }
}

Scopes

Returns only this scope or the stated sub-fields (e.g. title). There are three scopes:

  • fields

  • meta

  • includes

Value Syntax

Syntax

Description

a,b,c

comma-separated list will select multiple fields

a/b/c

path will select a field from its parent

a(b,c)

sub-selection will select many fields from a parent

a/*/c

the star * wildcard will select all items in a field

Examples

Find some examples on the collection examples page:

PreviousLocalisationNextIncludes

Last updated