Content Management API > Model filter

Create a new filter

Body parameters

id string Optional

RFC 4122 UUID of filter expressed in URL-safe base64 format

Example:

"FF-P5of6Qp-DD2w0xoaa6Q"

type string Required

Must be exactly "item_type_filter".

attributes.name string Required

The name of the filter

Example:

"Draft posts"

attributes.filter object Optional

The actual filter. It follows the form of the filter query parameter of the List all records endpoint.

Example:

{
  query: "foo bar",
  fields: {
    _status: { eq: "draft" },
    title: {
      matches: { pattern: "qux", case_sensitive: "false", regexp: "false" },
    },
  },
}

attributes.columns Optional

The columns to show with this filter

Type: Array<object>, null

Example:

[
  { name: "_preview", width: 0.6 },
  { name: "slug", width: 0.1 },
  { name: "_status", width: 0.1 },
  { name: "_updated_at", width: 0.2 },
]

name string Required

Can be either the API key of a model's field, or one of the following meta columns: id, _preview, _updated_at, _created_at, _creator, _status, _published_at, _first_published_at, _publication_scheduled_at, _unpublishing_scheduled_at, position (only for sortable models), `_stage (only for models associated with a workflow).

width number Required

The percentage width for the column (float, from 0 to 1.0)

attributes.order_by string, null Optional

The ordering to apply with this filter, or null for the default model ordering. It follows the form of the order_by query parameter of the List all records endpoint.

Example:

"_updated_at_ASC"

attributes.shared boolean Optional

Whether it's a shared filter or not

relationships.item_type.data Required

Model associated with the filter

Type: ResourceLinkage<"item_type">

Returns

Returns a resource object of type item_type_filter.

Examples

1
POST https://site-api.datocms.com/item-type-filters HTTP/1.1
2
Authorization: Bearer YOUR-API-TOKEN
3
Accept: application/json
4
X-Api-Version: 3
5
Content-Type: application/vnd.api+json
6

7
{
8
  "data": {
9
    "type": "item_type_filter",
10
    "attributes": {
11
      "name": "Draft posts"
12
    },
13
    "relationships": {
14
      "item_type": {
15
        "data": {
16
          "type": "item_type",
17
          "id": "DxMaW10UQiCmZcuuA-IkkA"
18
        }
19
      }
20
    }
21
  }
22
}

1
curl -g 'https://site-api.datocms.com/item-type-filters' \
2
  -X POST \
3
  -H "Authorization: Bearer YOUR-API-TOKEN" \
4
  -H "Accept: application/json" \
5
  -H "X-Api-Version: 3" \
6
  -H "Content-Type: application/vnd.api+json" \
7
  --data-binary '{"data":{"type":"item_type_filter","attributes":{"name":"Draft posts"},"relationships":{"item_type":{"data":{"type":"item_type","id":"DxMaW10UQiCmZcuuA-IkkA"}}}}}'

1
await fetch("https://site-api.datocms.com/item-type-filters", {
2
  method: "POST",
3
  headers: {
4
    Authorization: "Bearer YOUR-API-TOKEN",
5
    Accept: "application/json",
6
    "X-Api-Version": "3",
7
    "Content-Type": "application/vnd.api+json",
8
  },
9
  body: JSON.stringify({
10
    data: {
11
      type: "item_type_filter",
12
      attributes: { name: "Draft posts" },
13
      relationships: {
14
        item_type: {
15
          data: { type: "item_type", id: "DxMaW10UQiCmZcuuA-IkkA" },
16
        },
17
      },
18
    },
19
  }),
20
});

1
HTTP/1.1 200 OK
2
Content-Type: application/json
3
Cache-Control: cache-control: max-age=0, private, must-revalidate
4
X-RateLimit-Limit: 30
5
X-RateLimit-Remaining: 28
6

7
{
8
  "data": {
9
    "type": "item_type_filter",
10
    "id": "FF-P5of6Qp-DD2w0xoaa6Q",
11
    "relationships": {
12
      "item_type": {
13
        "data": {
14
          "type": "item_type",
15
          "id": "DxMaW10UQiCmZcuuA-IkkA"
16
        }
17
      }
18
    },
19
    "attributes": {
20
      "name": "Draft posts",
21
      "filter": {
22
        "query": "foo bar",
23
        "fields": {
24
          "_status": {
25
            "eq": "draft"
26
          },
27
          "title": {
28
            "matches": {
29
              "pattern": "qux",
30
              "case_sensitive": "false",
31
              "regexp": "false"
32
            }
33
          }
34
        }
35
      },
36
      "columns": [
37
        {
38
          "name": "_preview",
39
          "width": 0.6
40
        },
41
        {
42
          "name": "slug",
43
          "width": 0.1
44
        },
45
        {
46
          "name": "_status",
47
          "width": 0.1
48
        },
49
        {
50
          "name": "_updated_at",
51
          "width": 0.2
52
        }
53
      ],
54
      "order_by": "_updated_at_ASC",
55
      "shared": true
56
    }
57
  }
58
}

Did this doc help you?

Need help?

Explore our forum, contact support, or connect with our sales team . You can also chat live with other users in our Slack channel.