Versions

Enables users to create unpublished copies of an item, modify them independently from the main version, and promote them to become the new main version when ready.

List Content Versions

List all content versions that exist in Directus.

Query Parameters

fields

array

Control what fields are being returned in the object.

limit

integer

A limit on the number of objects that are returned.

offset

integer

How many items to skip when fetching data.

meta

string

What metadata to return in the response.

sort

array

How to sort the returned items. sort is a CSV of fields used to sort the fetched items. Sorting defaults to ascending (ASC) order but a minus sign (-) can be used to reverse this to descending (DESC) order. Fields are prioritized by their order in the CSV.

filter

Select items in collection by given conditions.

string

Filter by items that contain the given search query in one of their fields.

Responses

Successful request

data

array

meta

object

GET/versions

import { createDirectus, rest, readContentVersions } from '@directus/sdk';

const client = createDirectus('directus_project_url').with(rest());

const result = await client.request(readContentVersions(query_object));

GET /versions

POST /graphql/system

type Query {
	versions: [directus_versions]
}

Response Example

{
  "data": [
    {
      "id": "63716273-0f29-4648-8a2a-2af2948f6f78",
      "key": "draft",
      "name": "My Draft",
      "collection": "articles",
      "item": "168",
      "date_created": "2022-05-11T13:14:52Z",
      "date_updated": "2022-05-11T13:14:53Z",
      "user_created": "63716273-0f29-4648-8a2a-2af2948f6f78",
      "user_updated": "63716273-0f29-4648-8a2a-2af2948f6f78",
      "delta": {}
    }
  ],
  "meta": {}
}

Create Multiple Content Versions

Create multiple new content versions.

Query Parameters

fields

array

Control what fields are being returned in the object.

limit

integer

A limit on the number of objects that are returned.

meta

string

What metadata to return in the response.

offset

integer

How many items to skip when fetching data.

sort

array

filter

Select items in collection by given conditions.

string

Filter by items that contain the given search query in one of their fields.

Request Body

data

array

Responses

Successful request

data

array

meta

object

POST/versions

import { createDirectus, rest, updateContentVersions } from '@directus/sdk';

const client = createDirectus('directus_project_url').with(rest());

const result = await client.request(updateContentVersions(content_version_id_array, partial_content_version_object));

POST /versions

POST /graphql/system

type Mutation {
	update_versions_items(ids: [ID!]!, data: update_directus_versions_input!): [directus_versions]
}

Response Example

{
  "data": [
    {
      "id": "63716273-0f29-4648-8a2a-2af2948f6f78",
      "key": "draft",
      "name": "My Draft",
      "collection": "articles",
      "item": "168",
      "date_created": "2022-05-11T13:14:52Z",
      "date_updated": "2022-05-11T13:14:53Z",
      "user_created": "63716273-0f29-4648-8a2a-2af2948f6f78",
      "user_updated": "63716273-0f29-4648-8a2a-2af2948f6f78",
      "delta": {}
    }
  ],
  "meta": {}
}

Delete Multiple Content Versions

Delete multiple existing content versions.

Request Body

An array of content version primary keys.

[array]

array

Responses

The resource was deleted successfully.

DELETE/versions

import { createDirectus, rest, deleteContentVersions } from '@directus/sdk';

const client = createDirectus('directus_project_url').with(rest());

const result = await client.request(deleteContentVersions(content_version_id_array));

DELETE /versions

POST /graphql/system

type Mutation {
	delete_versions_items(ids: [ID!]!): delete_many
}

Update Multiple Content Versions

Update multiple content versions at the same time.

Query Parameters

fields

array

Control what fields are being returned in the object.

limit

integer

A limit on the number of objects that are returned.

meta

string

What metadata to return in the response.

offset

integer

How many items to skip when fetching data.

sort

array

filter

Select items in collection by given conditions.

string

Filter by items that contain the given search query in one of their fields.

Request Body

data

keys

array

Responses

Successful request

data

array

meta

object

PATCH/versions

import { createDirectus, rest, updateContentVersions } from '@directus/sdk';

const client = createDirectus('directus_project_url').with(rest());

const result = await client.request(updateContentVersions(content_version_id_array, partial_content_version_object));

PATCH /versions

POST /graphql/system

type Mutation {
	update_versions_items(ids: [ID!]!, data: update_directus_versions_input!): [directus_versions]
}

Response Example

{
  "data": [
    {
      "id": "63716273-0f29-4648-8a2a-2af2948f6f78",
      "key": "draft",
      "name": "My Draft",
      "collection": "articles",
      "item": "168",
      "date_created": "2022-05-11T13:14:52Z",
      "date_updated": "2022-05-11T13:14:53Z",
      "user_created": "63716273-0f29-4648-8a2a-2af2948f6f78",
      "user_updated": "63716273-0f29-4648-8a2a-2af2948f6f78",
      "delta": {}
    }
  ],
  "meta": {}
}

Create a Content Version

Create a new content version for an item.

Query Parameters

fields

array

Control what fields are being returned in the object.

meta

string

What metadata to return in the response.

Request Body

[object]

object

Responses

Successful request

data

object

POST/versions‎

import { createDirectus, rest, createContentVersion } from '@directus/sdk';

const client = createDirectus('directus_project_url').with(rest());

const result = await client.request(createContentVersion(content_version_object));

POST /versions‎

POST /graphql/system

type Mutation {
	create_versions_item(data: create_directus_versions_input!): directus_versions
}

Response Example

{
  "data": {
    "id": "63716273-0f29-4648-8a2a-2af2948f6f78",
    "key": "draft",
    "name": "My Draft",
    "collection": "articles",
    "item": "168",
    "date_created": "2022-05-11T13:14:52Z",
    "date_updated": "2022-05-11T13:14:53Z",
    "user_created": "63716273-0f29-4648-8a2a-2af2948f6f78",
    "user_updated": "63716273-0f29-4648-8a2a-2af2948f6f78",
    "delta": {}
  }
}

Retrieve a Content Version

Retrieve a single content version by unique identifier.

Query Parameters

string

Unique identifier for the object.

fields

array

Control what fields are being returned in the object.

meta

string

What metadata to return in the response.

Responses

Successful request

data

object

GET/versions/{id}

import { createDirectus, rest, readContentVersion } from '@directus/sdk';

const client = createDirectus('directus_project_url').with(rest());

const result = await client.request(readContentVersion(content_version_id, query_object));

GET /versions/{id}

POST /graphql/system

type Query {
	versions_by_id(id: ID!): directus_versions
}

Response Example

{
  "data": {
    "id": "63716273-0f29-4648-8a2a-2af2948f6f78",
    "key": "draft",
    "name": "My Draft",
    "collection": "articles",
    "item": "168",
    "date_created": "2022-05-11T13:14:52Z",
    "date_updated": "2022-05-11T13:14:53Z",
    "user_created": "63716273-0f29-4648-8a2a-2af2948f6f78",
    "user_updated": "63716273-0f29-4648-8a2a-2af2948f6f78",
    "delta": {}
  }
}

Delete a Content Version

Delete an existing content version.

Query Parameters

string

Unique identifier for the object.

Responses

The resource was deleted successfully.

DELETE/versions/{id}

import { createDirectus, rest, deleteContentVersion } from '@directus/sdk';

const client = createDirectus('directus_project_url').with(rest());

const result = await client.request(deleteContentVersion(content_version_id));

DELETE /versions/{id}

POST /graphql/system

type Mutation {
	delete_versions_item(id: ID!): delete_one
}

Update a Content Version

Update an existing content version.

Query Parameters

string

Unique identifier for the object.

fields

array

Control what fields are being returned in the object.

meta

string

What metadata to return in the response.

Request Body

[object]

object

Responses

Successful request

data

object

PATCH/versions/{id}

import { createDirectus, rest, updateContentVersion } from '@directus/sdk';

const client = createDirectus('directus_project_url').with(rest());

const result = await client.request(updateContentVersion(content_version_id, partial_content_version_object));

PATCH /versions/{id}

POST /graphql/system

type Mutation {
	update_versions_item(id: ID!, data: update_directus_versions_input!): directus_versions
}

Response Example

{
  "data": {
    "id": "63716273-0f29-4648-8a2a-2af2948f6f78",
    "key": "draft",
    "name": "My Draft",
    "collection": "articles",
    "item": "168",
    "date_created": "2022-05-11T13:14:52Z",
    "date_updated": "2022-05-11T13:14:53Z",
    "user_created": "63716273-0f29-4648-8a2a-2af2948f6f78",
    "user_updated": "63716273-0f29-4648-8a2a-2af2948f6f78",
    "delta": {}
  }
}

Compare a Content Version

Compare an existing content version with the main version of the item.

Query Parameters

string

Unique identifier for the object.

Responses

Successful request

data

object

GET/versions/{id}/compare

import { createDirectus, rest, compareContentVersion } from '@directus/sdk';

const client = createDirectus('directus_project_url').with(rest());

const result = await client.request(compareContentVersion(content_version_id));

GET /versions/{id}/compare

// Not supported in GraphQL

Response Example

{
  "data": {}
}

Promote a Content Version

Promote an existing content version to become the new main version of the item.

Query Parameters

string

Unique identifier for the object.

Request Body

mainHash

string

Hash of the main version of the item to be promoted.

fields

string

Optional array of field names of which the values are to be promoted.

Responses

Successful request

[string]

string

The primary key of the promoted item.

POST/versions/{id}/promote

import { createDirectus, rest, promoteContentVersion } from '@directus/sdk';

const client = createDirectus('directus_project_url').with(rest());

const result = await client.request(promoteContentVersion(content_version_id, promote_object));

POST /versions/{id}/promote

// Not supported in GraphQL

Save to a Content Version

Save item changes to an existing content version.

Query Parameters

string

Unique identifier for the object.

Responses

Successful request, Returns the item object with the new state after save.

data

object

POST/versions/{id}/save

import { createDirectus, rest, saveToContentVersion } from '@directus/sdk';

const client = createDirectus('directus_project_url').with(rest());

const result = await client.request(saveToContentVersion(content_version_id, partial_item_object));

POST /versions/{id}/save

// Not supported in GraphQL

Response Example

{
  "data": {}
}