/item

Last updated 10 days ago

Retrieves all 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.

get

/item

Authorizations

Query parameters

offsetany · default: 0

countany · default: 20

tagsany

categoryany

searchany

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/item' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Creates a new digital 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.

post

/item

Authorizations

Body

nameanyrequired

Pattern: [^_]\w+

displayNameanyrequired

descriptionanyrequired

categoryundefined · enumrequired

Options: FUNGIBLE, DISTINCT

tagsany

metadataSpecIdany

metadataany

publicVisibleany

metadataSpecany

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:8080/api/rest/item' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "name": null,
    "displayName": null,
    "description": null,
    "category": "FUNGIBLE",
    "tags": [],
    "metadataSpecId": null,
    "metadata": null,
    "publicVisible": null,
    "metadataSpec": null
  }'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Retrieves a single Item by id or by name

Looks up an item by the passed in identifier

get

/item/{identifier}

Authorizations

Path parameters

identifieranyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/item/{identifier}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Updates a single Item

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

put

/item/{identifier}

Authorizations

Path parameters

identifieranyrequired

Body

nameanyrequired

Pattern: [^_]\w+

displayNameanyrequired

descriptionanyrequired

tagsany

metadataSpecobject

Represents a spec for metadata.

metadataany

publicVisibleany

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://localhost:8080/api/rest/item/{identifier}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "name": null,
    "displayName": null,
    "description": null,
    "tags": [],
    "metadataSpec": {
      "id": null,
      "name": null,
      "type": "STRING",
      "properties": [
        "[Circular Reference]"
      ]
    },
    "metadata": null,
    "publicVisible": null
  }'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Retrieves all Items

Creates a new digital Item

Retrieves a single Item by id or by name

Updates a single Item

Show child attributes