Skip to main content

Item Service Panel

The Item Service Panel#

The Item Service panel allows you visibility into your Schemas, NamedUserCollections and NamedFileCollections in your projects and provides convenient methods for interacting with the Item Service.


Project Commands#

Create New Collection#

Creates either a new NamedUserCollection or NamedFileCollection based on the user's choice.

After clicking 'Create New Collection':

  1. Select either 'NamedUserCollection' or 'NamedFileCollection'
  2. Enter the prompted information to create the item
    • if NamedUserCollection, enter name, description, shortName, and _userType
    • if NamedFileCollection select a parent container, then enter name, description, and shortName

After the collection has been created document will open with the collection information.


Schema Folder Commands#

View Schema#

Opens a visual graph view of the Project's schema.

By default the Schema View will hide any collections without _itemTypes defined. You can view all the collections in th graph using the toggle in the left panel of the view.


Collections Folder Commands#

Create New NamedUserCollection#

Creates a new NamedUserCollection in the project given a name, description, shortName, and _userType.

After the collection has been created a document will open with the collection information.


Collection Commands#

Delete Collection#

Deletes a selected NamedUserCollection.

Delete and Recreate Collection#

Deletes the selected collections and creates it with the same name, description, shortName, and _userType.

This deletes the contents of the collection as well.

After the collection has been recreated a document will open with the collection information.

Get Newest 15 Items#

Get Newest 15 Items will open a new JSON document containing:

  1. The name of the collection which was peeked at
  2. The NamedUserItem for the NamedUserCollection
  3. The _total count of all items in the NamedUserCollection
  4. The _list of 15 newest items
  5. The _pageSize of the returned list of items
  6. The _offset of the returned list of items

Get Oldest 15 Items#

Get Oldest 15 Items will open a new JSON document containing:

  1. The name of the collection which was peeked at
  2. The NamedUserItem for the NamedUserCollection
  3. The _total count of all items in the NamedUserCollection
  4. The _list of 15 oldest items
  5. The _pageSize of the returned list of items
  6. The _offset of the returned list of items

File Collections Folder Commands#

Create New NamedFileCollection#

Creates a new NamedFileCollection allowing for selecting a parent container and given a name, description, and shortName.

After the collection has been created a document will open with the collection information.


File Collection Commands#

Delete Collection#

Deletes a selected NamedFileCollection.

Get Newest 15 Items#

Get Newest 15 Items will open a new JSON document containing:

  1. The name of the collection which was peeked at
  2. The NamedUserItem for the NamedUserCollection
  3. The _total count of all items in the NamedUserCollection
  4. The _list of 15 newest items
  5. The _pageSize of the returned list of items
  6. The _offset of the returned list of items

Get Oldest 15 Items#

Get Oldest 15 Items will open a new JSON document containing:

  1. The name of the collection which was peeked at
  2. The NamedUserItem for the NamedUserCollection
  3. The _total count of all items in the NamedUserCollection
  4. The _list of 15 oldest items
  5. The _pageSize of the returned list of items
  6. The _offset of the returned list of items