/item

Retrieves all Items

get

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.

Authorizations

auth_bearersession_secret

Query parameters

offsetanyOptionalDefault: 0

countanyOptionalDefault: 20

tagsanyOptional

categoryanyOptional

searchanyOptional

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

get

HTTPcURLJavaScriptPython

GET /api/rest/item HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

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

Creates a new digital Item

post

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.

Authorizations

auth_bearersession_secret

Body

nameanyRequiredPattern: [^_]\w+

displayNameanyRequired

descriptionanyRequired

categoryundefined · enumRequiredPossible values:

tagsanyOptional

metadataSpecIdanyOptional

metadataanyOptional

publicVisibleanyOptional

metadataSpecanyWrite-onlyOptional

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

post

HTTPcURLJavaScriptPython

POST /api/rest/item HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 162

{
  "name": null,
  "displayName": null,
  "description": null,
  "category": "FUNGIBLE",
  "tags": [],
  "metadataSpecId": null,
  "metadata": null,
  "publicVisible": null,
  "metadataSpec": null
}

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

Retrieves a single Item by id or by name

get

Looks up an item by the passed in identifier

Authorizations

auth_bearersession_secret

Path parameters

identifieranyRequired

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

get

HTTPcURLJavaScriptPython

GET /api/rest/item/{identifier} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

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

Updates a single Item

put

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

Authorizations

auth_bearersession_secret

Path parameters

identifieranyRequired

Body

nameanyRequiredPattern: [^_]\w+

displayNameanyRequired

descriptionanyRequired

tagsanyOptional

metadataanyOptional

publicVisibleanyOptional

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

put

HTTPcURLJavaScriptPython

PUT /api/rest/item/{identifier} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 427

{
  "name": null,
  "displayName": null,
  "description": null,
  "tags": [],
  "metadataSpec": {
    "id": null,
    "name": null,
    "type": "STRING",
    "properties": [
      {
        "name": null,
        "displayName": null,
        "type": "STRING",
        "required": null,
        "placeholder": null,
        "defaultValue": null,
        "properties": [
          {
            "name": null,
            "displayName": null,
            "type": "STRING",
            "required": null,
            "placeholder": null,
            "defaultValue": null,
            "properties": "[Circular Reference]"
          }
        ]
      }
    ]
  },
  "metadata": null,
  "publicVisible": null
}

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