UI Extensions API

Bu içerik henüz dilinizde mevcut değil.

List UI extensions
Get a single UI extension
Create a UI extension
Update a UI extension
Fields

List UI extensions

List all UI extensions for an account:

GET /ui_extensions

Response

Status: 200 OK

[
  {
    "id": 3,
    "name": "Location Move",
    "disabled": false,
    "created_at": "2016-03-18T19:04:06-05:00",
    "updated_at": "2016-03-18T19:04:06-05:00",
    "active_version": {
      "id": 7,
      "name": "Location Move",
      "version": 1
    },
    "prepared_version": {
      "id": 8,
      "name": "Location Move",
      "version": 2
    }
  },
  {
    "id": 2,
    "name": "SAP Finance field option",
    "disabled": false,
    "created_at": "2016-03-18T19:04:06-05:00",
    "updated_at": "2016-03-18T19:04:06-05:00",
    "active_version": {
      "id": 5,
      "name": "SAP Finance field option",
      "version": 1
    },
    "prepared_version": {
      "id": 6,
      "name": "SAP Finance field option",
      "version": 2
    }
  }
]

The response contains these fields by default. Filtering and pagination are available to reduce/limit the collection of UI extensions.

Collection Fields

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

active_version created_at disabled id sourceID name prepared_version updated_at

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

Filtering

Filtering is available for the following fields :

id source sourceID name created_at updated_at disabled

Sorting

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

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

id sourceID name created_at updated_at

Get a single UI extension

GET /ui_extensions/:id

Response

Status: 200 OK

{
  "active_version": {
    "id": 7,
    "name": "Location Move",
    "version": 1
  },
  "category": "request_template",
  "created_at": "2016-03-18T19:04:06-05:00",
  "css": ".row.subject {\n  display: none;\n}",
  "description": "Location move request template UI Extension",
  "disabled": false,
  "html": "<div class=\"row vertical\">\n  <label for=\"move_from\">Move from</label>\n  <input id=\"move_from\" type=\"text\" class=\"required add-to-subject\">\n</div>\n\n<div class=\"row vertical\">\n  <label for=\"move_to\">Move to</label>\n  <input id=\"move_to\" type=\"text\" class=\"required add-to-subject\">\n</div>",
  "id": 3,
  "javascript": null,
  "name": "Location Move",
  "phrases": [
    "Move from",
    "Move to"
  ],
  "prepared_version": {
    "id": 8,
    "name": "Location Move",
    "version": 2
  },
  "compiled_css": ".row.subject {\n  display: none; }\n",
  "localized_html": "<div>\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><div class=\"row vertical\"><label for=\"move_to\">Verplaats naar</label><input id=\"move_to\" type=\"text\" class=\"required add-to-subject\">\n</div>\n</div>",
  "title": "Information",
  "localized_title": "Informatie",
  "updated_at": "2016-03-18T19:04:06-05:00"
}

The response contains these fields .

Create a UI extension

POST /ui_extensions

When creating a new UI extension these fields are available.

Response

Status: 201 Created

{
  "name": "...",
  "...": "..."
}

The response contains all fields of the created UI extension and is similar to the response in Get a single UI extension

Update a UI extension

PATCH /ui_extensions/:id

When updating a UI extension these fields are available.

Response

Status: 200 OK

{
  "name": "...",
  "...": "..."
}

The response contains all fields of the updated UI extension and is similar to the response in Get a single UI extension

Fields

activate

Optional boolean , default: false — Set to true to promote the Prepared Version to the Active Version. If the was an Active Version, it will be Archived.

active_version

Readonly Optional reference to UI extension Version The version with Status active .