API : Elements

GET element

Return data about the specified element:

Request

GET /elements/:id

Response

{
  "id": 1,
  "url": "http://yourdomain.com/api/elements/1",
  "name": "Text",
  "order": 1,
  "description": "Any textual data included in the document",
  "comment": null,
  "element_set": {"id": 1, "url": "http://yourdomain.com/api/element_sets/1"},
}

GET elements

Return data about elements:

Request

GET /elements

Parameters

• element_set: integer
• name: string
• item_type: integer

Response

An array of JSON element representations (see above).

POST element

Create a new element.

Request

POST /elements

{
  "order": 1,
  "name": "Foo",
  "description": "Foo description.",
  "comment": "Foo comment.",
  "element_set": {"id": 1}
}

Response

Location: http://yourdomain.com/api/elements/:id

An JSON representation of the newly created element (see above).

PUT element

Edit an existing element.

Request

PUT /elements/:id

{
  "order": 1,
  "name": "Foo",
  "description": "Foo description.",
  "comment": "Foo comment.",
  "element_set": {"id": 1}
}

Response

An JSON representation of the newly edited element (see above).

DELETE element

Delete an element. Only elements belonging to the "Item Type Metadata" element set may be deleted.

Request

DELETE /elements/:id

Response

An 204 No Content response.

Errors

In addition to the general errors, requests to the elements resource my return the following errors:

• 400 Bad Request
  • Invalid record. Only elements belonging to the "Item Type Metadata" element set may be deleted.