Versions

Create or update a new setting

Create a new Settings css-override

post

/customize-ui

Authorizations

passportbearer

Body

variablesstring

sansSerifFontstring

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/1.0/customize-ui' \
  --header 'Content-Type: application/json'

201

201

{
  "key": "text",
  "name": "text",
  "helper": "text",
  "group": "text",
  "format": "text",
  "hidden": true,
  "readonly": true,
  "variables": "text",
  "sansSerifFont": "text",
  "config": [
    {}
  ],
  "id": "text",
  "created_at": "2025-02-20T18:58:56.255Z",
  "updated_at": "2025-02-20T18:58:56.255Z"
}

success

Return all version History according to the model

Get the list of records of Version History

get

/version_histories

Authorizations

passportbearer

Query parameters

filterstring

Filter results by string. Searches Name, Description, and Status. Status must match exactly. Others can be a substring.

order_bystring

Field to order results by

order_directionstring · enum · default: asc

Options: asc, desc

per_pageinteger · default: 10

includestring

Include data from related models in payload. Comma separated list.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/1.0/version_histories'

200

200

{
  "data": [
    {
      "versionable_id": 1,
      "versionable_type": "text",
      "name": "text",
      "subject": "text",
      "description": "text",
      "status": "ACTIVE",
      "created_at": "2025-02-20T18:58:56.255Z",
      "updated_at": "2025-02-20T18:58:56.255Z"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "count": 1,
    "total_pages": 1,
    "current_page": 1,
    "form": 1,
    "last_page": 1,
    "path": "text",
    "per_page": 1,
    "to": 1,
    "total": 1,
    "sort_order": "asc"
  }
}

list of Version History

Save a new Version History

Create a new Version History.

post

/version_histories

Authorizations

passportbearer

Body

versionable_idinteger

Class VersionHistoryCollection

versionable_typestring

namestring

subjectstring

descriptionstring

statusstring · enum

Options: ACTIVE, INACTIVE

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/1.0/version_histories' \
  --header 'Content-Type: application/json' \
  --data '{"status":"ACTIVE"}'

201

201

{
  "versionable_id": 1,
  "versionable_type": "text",
  "name": "text",
  "subject": "text",
  "description": "text",
  "status": "ACTIVE",
  "created_at": "2025-02-20T18:58:56.255Z",
  "updated_at": "2025-02-20T18:58:56.255Z"
}

success

Get single Version History by ID

Get a single Version History.

get

/version_histories/{version_history_id}

Authorizations

passportbearer

Path parameters

version_history_idstringrequired

ID of Version History to return

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/1.0/version_histories/{version_history_id}'

200

200

{
  "versionable_id": 1,
  "versionable_type": "text",
  "name": "text",
  "subject": "text",
  "description": "text",
  "status": "ACTIVE",
  "created_at": "2025-02-20T18:58:56.255Z",
  "updated_at": "2025-02-20T18:58:56.255Z"
}

Successfully found the Version History

Update a Version History

Update a Version History.

put

/version_histories/{version_history_id}

Authorizations

passportbearer

Path parameters

version_history_idstringrequired

ID of Version History to return

Body

versionable_idinteger

Class VersionHistoryCollection

versionable_typestring

namestring

subjectstring

descriptionstring

statusstring · enum

Options: ACTIVE, INACTIVE

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/1.0/version_histories/{version_history_id}' \
  --header 'Content-Type: application/json' \
  --data '{"status":"ACTIVE"}'

204

204

{
  "versionable_id": 1,
  "versionable_type": "text",
  "name": "text",
  "subject": "text",
  "description": "text",
  "status": "ACTIVE",
  "created_at": "2025-02-20T18:58:56.255Z",
  "updated_at": "2025-02-20T18:58:56.255Z"
}

success

Delete a Version History

Delete a Version History.

delete

/version_histories/{version_history_id}

Authorizations

passportbearer

Path parameters

version_history_idstringrequired

ID of Version History to return

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/1.0/version_histories/{version_history_id}'

204

204

{
  "versionable_id": 1,
  "versionable_type": "text",
  "name": "text",
  "subject": "text",
  "description": "text",
  "status": "ACTIVE",
  "created_at": "2025-02-20T18:58:56.255Z",
  "updated_at": "2025-02-20T18:58:56.255Z"
}

success

Clone a new Version History

Clone a new Version History.

post

/version_histories/clone

Authorizations

passportbearer

Body

versionable_idinteger

Class VersionHistoryCollection

versionable_typestring

namestring

subjectstring

descriptionstring

statusstring · enum

Options: ACTIVE, INACTIVE

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/1.0/version_histories/clone' \
  --header 'Content-Type: application/json' \
  --data '{"status":"ACTIVE"}'

201

201

{
  "versionable_id": 1,
  "versionable_type": "text",
  "name": "text",
  "subject": "text",
  "description": "text",
  "status": "ACTIVE",
  "created_at": "2025-02-20T18:58:56.255Z",
  "updated_at": "2025-02-20T18:58:56.255Z"
}

success