Skip to main content

Creates a collection item

POST /v1/collectionitem/{collectionID}

Summary​

Creates a collection item.

Details​

Request body: JSON object. Accepted values include

itemType values of device, user, or file. The caller must have write access

to the collection and read access to the item being added.

Authentication​

No operation-level security requirement is documented here.

Parameters​

NameInTypeRequiredDescriptionExample
collectionIDpathinteger (int64)YesThe ID of the collection that will receive the item.1

Request Body​

Required: Yes

application/json​

  • itemType (string, optional)
  • itemID (integer (int64), optional)

Example

{
  "itemType": "Example value",
  "itemID": 1
}

Responses​

200​

Success

application/json​

  • key (integer (int64), optional)
  • collectionID (integer (int64), optional)
  • itemTypeID (integer (int64), optional)
  • itemID (integer (int64), optional)
  • creationDate (string (date-time), optional)

Example

{
  "key": 1,
  "collectionID": 1,
  "itemTypeID": 1,
  "itemID": 1,
  "creationDate": "2026-03-30T12:00:00.0000000Z"
}