processmaker.comKnowledge CenterProcessMaker University
Edit

Versions

Create or update a new setting

post

Create a new Settings css-override

Authorizations
Body
variablesstringOptional
sansSerifFontstringOptional
Responses
201

success

application/json
Responseall of
post
POST /api/1.0/customize-ui HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "variables": "text",
  "sansSerifFont": "text"
}
201

success

{
  "key": "text",
  "config": [
    {}
  ],
  "name": "text",
  "helper": "text",
  "group": "text",
  "format": "text",
  "hidden": true,
  "readonly": true,
  "variables": "text",
  "sansSerifFont": "text",
  "id": "text",
  "created_at": "2025-08-31T05:39:12.688Z",
  "updated_at": "2025-08-31T05:39:12.688Z"
}

Return all version History according to the model

get

Get the list of records of Version History

Authorizations
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 · enumOptionalDefault: ascPossible values:
per_pageintegerOptionalDefault: 10
includestringOptional

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

Default: ""
Responses
200

list of Version History

application/json
get
GET /api/1.0/version_histories HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
200

list of Version History

{
  "data": [
    {
      "versionable_id": 1,
      "versionable_type": "text",
      "name": "text",
      "subject": "text",
      "description": "text",
      "status": "ACTIVE",
      "created_at": "2025-08-31T05:39:12.688Z",
      "updated_at": "2025-08-31T05:39:12.688Z"
    }
  ],
  "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
  }
}

Save a new Version History

post

Create a new Version History.

Authorizations
Body
versionable_idintegerOptional

Class VersionHistoryCollection

versionable_typestringOptional
namestringOptional
subjectstringOptional
descriptionstringOptional
statusstring · enumOptionalPossible values:
Responses
201

success

application/json
Responseall of
and
post
POST /api/1.0/version_histories HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 116

{
  "versionable_id": 1,
  "versionable_type": "text",
  "name": "text",
  "subject": "text",
  "description": "text",
  "status": "ACTIVE"
}
201

success

{
  "versionable_id": 1,
  "versionable_type": "text",
  "name": "text",
  "subject": "text",
  "description": "text",
  "status": "ACTIVE",
  "created_at": "2025-08-31T05:39:12.688Z",
  "updated_at": "2025-08-31T05:39:12.688Z"
}

Get single Version History by ID

get

Get a single Version History.

Authorizations
Path parameters
version_history_idstringRequired

ID of Version History to return

Responses
200

Successfully found the Version History

application/json
Responseall of
and
get
GET /api/1.0/version_histories/{version_history_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
200

Successfully found the Version History

{
  "versionable_id": 1,
  "versionable_type": "text",
  "name": "text",
  "subject": "text",
  "description": "text",
  "status": "ACTIVE",
  "created_at": "2025-08-31T05:39:12.688Z",
  "updated_at": "2025-08-31T05:39:12.688Z"
}

Update a Version History

put

Update a Version History.

Authorizations
Path parameters
version_history_idstringRequired

ID of Version History to return

Body
versionable_idintegerOptional

Class VersionHistoryCollection

versionable_typestringOptional
namestringOptional
subjectstringOptional
descriptionstringOptional
statusstring · enumOptionalPossible values:
Responses
204

success

application/json
Responseall of
and
put
PUT /api/1.0/version_histories/{version_history_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 116

{
  "versionable_id": 1,
  "versionable_type": "text",
  "name": "text",
  "subject": "text",
  "description": "text",
  "status": "ACTIVE"
}
204

success

{
  "versionable_id": 1,
  "versionable_type": "text",
  "name": "text",
  "subject": "text",
  "description": "text",
  "status": "ACTIVE",
  "created_at": "2025-08-31T05:39:12.688Z",
  "updated_at": "2025-08-31T05:39:12.688Z"
}

Delete a Version History

delete

Delete a Version History.

Authorizations
Path parameters
version_history_idstringRequired

ID of Version History to return

Responses
204

success

application/json
Responseall of
and
delete
DELETE /api/1.0/version_histories/{version_history_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
204

success

{
  "versionable_id": 1,
  "versionable_type": "text",
  "name": "text",
  "subject": "text",
  "description": "text",
  "status": "ACTIVE",
  "created_at": "2025-08-31T05:39:12.688Z",
  "updated_at": "2025-08-31T05:39:12.688Z"
}

Clone a new Version History

post

Clone a new Version History.

Authorizations
Body
versionable_idintegerOptional

Class VersionHistoryCollection

versionable_typestringOptional
namestringOptional
subjectstringOptional
descriptionstringOptional
statusstring · enumOptionalPossible values:
Responses
201

success

application/json
Responseall of
and
post
POST /api/1.0/version_histories/clone HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 116

{
  "versionable_id": 1,
  "versionable_type": "text",
  "name": "text",
  "subject": "text",
  "description": "text",
  "status": "ACTIVE"
}
201

success

{
  "versionable_id": 1,
  "versionable_type": "text",
  "name": "text",
  "subject": "text",
  "description": "text",
  "status": "ACTIVE",
  "created_at": "2025-08-31T05:39:12.688Z",
  "updated_at": "2025-08-31T05:39:12.688Z"
}
PreviousSaved SearchNextPostman Collection

Last updated