elements_item

Item

The Item endpoints.

Functions

This module offers a collection of functions designed to address specific tasks and provide utilities for various purposes. Explore the available functions to make the most of the functionalities provided by this module.

• elements_create_item
• elements_delete_item
• elements_get_item_by_identifier
• elements_get_items
• elements_update_item

---

Back To Top

elements_create_item

Supplying an item object, this will create a new item with a newly assigned unique id. The Item representation returned in the response body is a representation of the Item as persisted with a unique identifier signed and with its fields properly normalized. The supplied item object submitted with the request must have a name property that is unique across all items.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_create_item(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsCreateItemRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsItem or Undefined
_request	ElementsRequest

---

Back To Top

elements_delete_item

Delete the item as identified by the given item name/id

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_delete_item(_identifier, _callback=undefined)

Argument	Type	Description
_identifier	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	ElementsRequest

---

Back To Top

elements_get_item_by_identifier

Looks up an item by the passed in identifier

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_item_by_identifier(_identifier, _callback=undefined)

Argument	Type	Description
_identifier	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsItem or Undefined
_request	ElementsRequest

---

Back To Top

elements_get_items

Searches all items and returns all matching items, filtered by the passed in search parameters. If multiple tags are specified, then all items that contain at least one of the passed in tags is returned.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_items(_offset=undefined, _count=undefined, _tags=undefined, _category=undefined, _search=undefined, _callback=undefined)

Argument	Type	Description
_offset	Real
_count	Real
_tags	Array of String
_category	String
_search	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsPaginationItem or Undefined
_request	ElementsRequest

---

Back To Top

elements_update_item

Supplying an item, this will update the Item identified by the identifier in the path with contents from the passed in request body.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_update_item(_identifier, _body=undefined, _callback=undefined)

Argument	Type	Description
_identifier	String
_body	ElementsUpdateItemRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsItem or Undefined
_request	ElementsRequest

---