UI Extensions - Versions API

List versions of a UI extension

List all versions of the UI extension with the given :id.

GET /ui_extensions/:id/versions

Response

Status: 200 OK
[
  {
    "id": 7,
    "name": "Location Move",
    "version_nr": 1,
    "status": "active",
    "approval_status": "approved",
    "activated_at": "2016-02-25T03:01:00-06:00",
    "archived_at": null,
    "created_at": "2016-02-22T02:40:00-06:00",
    "updated_at": "2016-03-18T19:04:06-05:00"
  },
  {
    "id": 8,
    "name": "Location Move",
    "version_nr": 2,
    "status": "being_prepared",
    "approval_status": "pending",
    "activated_at": null,
    "archived_at": null,
    "created_at": "2016-03-18T19:04:06-05:00",
    "updated_at": "2016-03-18T19:04:06-05:00"
  }
]

The response contains these fields by default.

Collection Fields

By default the following fields will appear in collections of UI extensions:

activated_at archived_at created_at id name status updated_at version_nr

Obtain a different set of fields using the ?fields= parameter.

Sorting

By default a collection of UI extensions is sorted ascending by id.

The following fields are accepted by the ?sort= parameter:

id version_nr status created_at updated_at

Get a single version of a UI extension

GET /ui_extensions/:id/versions/:id

Response

Status: 200 OK
{
  "activated_at": null,
  "approval_status": "pending",
  "archived_at": null,
  "created_at": "2016-03-18T19:04:06-05:00",
  "css": ".row.subject {\n  display: none;\n}",
  "html": "<div class=\"row vertical\">\n  <label for=\"move_from\">Move from\n  <input id=\"move_from\" type=\"text\" class=\"required add-to-subject\">\n\n\n<div class=\"row vertical\">\n  <label for=\"move_to\">Move to\n  <input id=\"move_to\" type=\"text\" class=\"required add-to-subject\">\n",
  "id": 8,
  "javascript": null,
  "name": "Location Move",
  "phrases": [
    "Move from",
    "Move to"
  ],
  "status": "being_prepared",
  "updated_at": "2016-03-18T19:04:06-05:00",
  "version_nr": 2,
  "compiled_css": ".row.subject {\n  display: none; }\n",
  "localized_html": "\n<div class=\"row vertical\"><label for=\"move_from\">Verplaats van/label><input id=\"move_from\" type=\"text\" class=\"required add-to-subject\">\n<div class=\"row vertical\"><label for=\"move_to\">Verplaats naar<input id=\"move_to\" type=\"text\" class=\"required add-to-subject\">\n\n",
  "ui_extension": {
    "id": 3,
    "name": "Location Move"
  },
  "formatted_activated_at": "",
  "formatted_archived_at": "",
  "view_audit_path": "/ui_extensions/3/versions/8/audit"
}

The response contains these fields.

Create a version in a UI extension

When a UI extension is activated using the activate field, a new version with status being_prepared is created for that UI extension.

Update a version of a UI extension

When the html, css or javascript field of a UI extension is updated, the version with status being_prepared will be updated.

Fields

activated_at
Readonly datetime — The date and time at which this version of the UI extension was activated.
archived_at
Readonly datetime — The date and time at which this version of the UI extension was archived.
approval_status
Readonly enum — The Approval Status field indicates the location in the approval life-cycle. If no javascript is provided, the status is always approved. Valid values are:
  • pending: Pending
  • rejected: Rejected
  • approved: Approved
created_at
Readonly datetime — The date and time at which this version of the UI extension was created.
css
Readonly text (max 64KB) — The CSS stylesheet.
compiled_css
Readonly text (max 64KB) — The compiled CSS stylesheet (only available when a single version is retrieved).
html
Readonly text (max 64KB) — The HTML code.
localized_html
Readonly text (max 64KB) — The HTML code with all phrases translated in the current users locale (only available when a single version is retrieved).
id
Readonly integer — The unique ID of this version of the UI extension.
javascript
Optional text (max 64KB) — The Javascript code.
name
Readonly string — The Name of the UI extension at the time this version was created.
phrases
Readonly array — The translatable phrases found in the HTML code.
status
Readonly enum, default: being_prepared — The Status field indicates the location in the life-cycle. Valid values are:
  • being_prepared: Being Prepared
  • active: Active
  • archived: Archived
updated_at
Readonly datetime — The date and time of the last update of this version of the UI extension. If this version of the UI extension has no updates it contains the created_at value.
version_nr
Readonly integer — The version number (1..) of this version of the UI extension.
view_audit_path
Readonly text (max 64KB) — The URI to the Audit Lines of this version of the UI extension.