Versions

Create or update a new setting

Create a new Settings css-override

POST/api/1.0/customize-ui

Body

application/json

variablesstring

sansSerifFontstring

Response

201

success

Body

application/json

keystring

Class Settings

configarray of object

namestring

helperstring

groupstring

formatstring

hiddenboolean

readonlyboolean

variablesstring

sansSerifFontstring

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/api/1.0/customize-ui', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201

{
  "key": "text",
  "config": [],
  "name": "text",
  "helper": "text",
  "group": "text",
  "format": "text",
  "hidden": false,
  "readonly": false,
  "variables": "text",
  "sansSerifFont": "text",
  "id": "text",
  "created_at": "2024-11-16T07:59:35.137Z",
  "updated_at": "2024-11-16T07:59:35.137Z"
}

Return all version History according to the model

Get the list of records of Version History

GET/api/1.0/version_histories

Query parameters

Response

200

list of Version History

Body

application/json

dataarray of versionHistory (object)

metaobject

Request

JavaScriptCurlPython

const response = await fetch('/api/1.0/version_histories', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "data": [
    {
      "versionable_type": "text",
      "name": "text",
      "subject": "text",
      "description": "text",
      "status": "ACTIVE",
      "created_at": "2024-11-16T07:59:35.137Z",
      "updated_at": "2024-11-16T07:59:35.137Z"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "path": "text"
  }
}

Save a new Version History

Create a new Version History.

POST/api/1.0/version_histories

Body

application/json

versionable_idinteger

Class VersionHistoryCollection

versionable_typestring

namestring

subjectstring

descriptionstring

statusenum

ACTIVEINACTIVE

Response

201

success

Body

application/json

versionable_idinteger

Class VersionHistoryCollection

versionable_typestring

namestring

subjectstring

descriptionstring

statusenum

ACTIVEINACTIVE

created_atstring (date-time)

updated_atstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/api/1.0/version_histories', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201

{
  "versionable_type": "text",
  "name": "text",
  "subject": "text",
  "description": "text",
  "status": "ACTIVE",
  "created_at": "2024-11-16T07:59:35.137Z",
  "updated_at": "2024-11-16T07:59:35.137Z"
}

Get single Version History by ID

Get a single Version History.

GET/api/1.0/version_histories/{version_history_id}

Path parameters

version_history_id*string

ID of Version History to return

Response

200

Successfully found the Version History

Body

application/json

versionable_idinteger

Class VersionHistoryCollection

versionable_typestring

namestring

subjectstring

descriptionstring

statusenum

ACTIVEINACTIVE

created_atstring (date-time)

updated_atstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/api/1.0/version_histories/{version_history_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "versionable_type": "text",
  "name": "text",
  "subject": "text",
  "description": "text",
  "status": "ACTIVE",
  "created_at": "2024-11-16T07:59:35.137Z",
  "updated_at": "2024-11-16T07:59:35.137Z"
}

Update a Version History

Update a Version History.

PUT/api/1.0/version_histories/{version_history_id}

Path parameters

version_history_id*string

ID of Version History to return

Body

application/json

versionable_idinteger

Class VersionHistoryCollection

versionable_typestring

namestring

subjectstring

descriptionstring

statusenum

ACTIVEINACTIVE

Response

204

success

Body

application/json

versionable_idinteger

Class VersionHistoryCollection

versionable_typestring

namestring

subjectstring

descriptionstring

statusenum

ACTIVEINACTIVE

created_atstring (date-time)

updated_atstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/api/1.0/version_histories/{version_history_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

204

{
  "versionable_type": "text",
  "name": "text",
  "subject": "text",
  "description": "text",
  "status": "ACTIVE",
  "created_at": "2024-11-16T07:59:35.137Z",
  "updated_at": "2024-11-16T07:59:35.137Z"
}

Delete a Version History

Delete a Version History.

DELETE/api/1.0/version_histories/{version_history_id}

Path parameters

version_history_id*string

ID of Version History to return

Response

204

success

Body

application/json

versionable_idinteger

Class VersionHistoryCollection

versionable_typestring

namestring

subjectstring

descriptionstring

statusenum

ACTIVEINACTIVE

created_atstring (date-time)

updated_atstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/api/1.0/version_histories/{version_history_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

204

{
  "versionable_type": "text",
  "name": "text",
  "subject": "text",
  "description": "text",
  "status": "ACTIVE",
  "created_at": "2024-11-16T07:59:35.137Z",
  "updated_at": "2024-11-16T07:59:35.137Z"
}

Clone a new Version History

Clone a new Version History.

POST/api/1.0/version_histories/clone

Body

application/json

versionable_idinteger

Class VersionHistoryCollection

versionable_typestring

namestring

subjectstring

descriptionstring

statusenum

ACTIVEINACTIVE

Response

201

success

Body

application/json

versionable_idinteger

Class VersionHistoryCollection

versionable_typestring

namestring

subjectstring

descriptionstring

statusenum

ACTIVEINACTIVE

created_atstring (date-time)

updated_atstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/api/1.0/version_histories/clone', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201

{
  "versionable_type": "text",
  "name": "text",
  "subject": "text",
  "description": "text",
  "status": "ACTIVE",
  "created_at": "2024-11-16T07:59:35.137Z",
  "updated_at": "2024-11-16T07:59:35.137Z"
}