Versions

Create or update a new setting

post

Create a new Settings css-override

Authorizations

passportbearer

Body

variablesstringoptional

sansSerifFontstringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/1.0/customize-ui' \
  --header 'Content-Type: application/json' \
  --data '{
    "variables": "text",
    "sansSerifFont": "text"
  }'

201

201

{
  "key": "text",
  "config": [
    {}
  ],
  "name": "text",
  "helper": "text",
  "group": "text",
  "format": "text",
  "hidden": true,
  "readonly": true,
  "variables": "text",
  "sansSerifFont": "text",
  "id": "text",
  "created_at": "2025-03-28T00:29:43.023Z",
  "updated_at": "2025-03-28T00:29:43.023Z"
}

success

Return all version History according to the model

get

Get the list of records of Version History

Authorizations

passportbearer

Query parameters

filterstringoptional

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

order_bystringoptional

Field to order results by

order_directionstring · enum · default: "asc"optional

Options: asc, desc

per_pageinteger · default: "10"optional

includestring · default: ""optional

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-03-28T00:29:43.023Z",
      "updated_at": "2025-03-28T00:29:43.023Z"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "count": 1,
    "total_pages": 1,
    "current_page": 1,
    "form": 1,
    "last_page": 1,
    "path": "text",
    "per_page": 1,
    "to": 1,
    "total": 1
  }
}

list of Version History

Save a new Version History

post

Create a new Version History.

Authorizations

passportbearer

Body

versionable_idintegeroptional

Class VersionHistoryCollection

versionable_typestringoptional

namestringoptional

subjectstringoptional

descriptionstringoptional

statusstring · enumoptional

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 '{
    "versionable_id": 1,
    "versionable_type": "text",
    "name": "text",
    "subject": "text",
    "description": "text",
    "status": "ACTIVE"
  }'

201

201

{
  "versionable_id": 1,
  "versionable_type": "text",
  "name": "text",
  "subject": "text",
  "description": "text",
  "status": "ACTIVE",
  "created_at": "2025-03-28T00:29:43.023Z",
  "updated_at": "2025-03-28T00:29:43.023Z"
}

success

Get single Version History by ID

get

Get a single Version History.

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-03-28T00:29:43.023Z",
  "updated_at": "2025-03-28T00:29:43.023Z"
}

Successfully found the Version History

Update a Version History

put

Update a Version History.

Authorizations

passportbearer

Path parameters

version_history_idstringrequired

ID of Version History to return

Body

versionable_idintegeroptional

Class VersionHistoryCollection

versionable_typestringoptional

namestringoptional

subjectstringoptional

descriptionstringoptional

statusstring · enumoptional

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 '{
    "versionable_id": 1,
    "versionable_type": "text",
    "name": "text",
    "subject": "text",
    "description": "text",
    "status": "ACTIVE"
  }'

204

204

{
  "versionable_id": 1,
  "versionable_type": "text",
  "name": "text",
  "subject": "text",
  "description": "text",
  "status": "ACTIVE",
  "created_at": "2025-03-28T00:29:43.023Z",
  "updated_at": "2025-03-28T00:29:43.023Z"
}

success

Delete a Version History

delete

Delete a Version History.

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-03-28T00:29:43.023Z",
  "updated_at": "2025-03-28T00:29:43.023Z"
}

success

Clone a new Version History

post

Clone a new Version History.

Authorizations

passportbearer

Body

versionable_idintegeroptional

Class VersionHistoryCollection

versionable_typestringoptional

namestringoptional

subjectstringoptional

descriptionstringoptional

statusstring · enumoptional

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 '{
    "versionable_id": 1,
    "versionable_type": "text",
    "name": "text",
    "subject": "text",
    "description": "text",
    "status": "ACTIVE"
  }'

201

201

{
  "versionable_id": 1,
  "versionable_type": "text",
  "name": "text",
  "subject": "text",
  "description": "text",
  "status": "ACTIVE",
  "created_at": "2025-03-28T00:29:43.023Z",
  "updated_at": "2025-03-28T00:29:43.023Z"
}

success