Version: v5.1

Item Service resource types

Overview#

The Item Service emits events when certain actions are taken in the system. The Notification Service can listen to these events and perform additional actions. For example, in the Notification Service, event triggers are set up which listen to events and determine when to send a notification.

Events are linked to resources. The actual type of the resource is indicated by the resource.type property. The other properties shown for a given resource depend on the type.

This page lists the resource types which are specific to the Item Service, and the events which are common to all services.

Event filtering#

In an event type trigger, filtering on the properties of an incoming event is supported.

An event filter is of the form:

{  "filter": {    <property...>: <wildcard>  }}

For example, to match create events from the Item Service, the event filter would look like the code listing below.

{  "filter": {    "event": "resource.ResourceCreated",    "resource.type": "itemsvc.*"  }}

Common events#

This section lists the events which are common to all services.

resource.ResourceCreated#

A resource created event is emitted when a resource is created.

Property	Type
`uuid`	UUID
`resource`
`user`
`_id`	string
`timestamp`	timestamp
`requestId`	string

Example event#

{    "event": "resource.ResourceCreated",    "uuid": "8f2792c7-b01a-4493-ba5a-d0588a4aad8e",    "resource": {        "type": "custom.Resource",        ...    }    "user": {        "id": "00b82755-b5e6-4c8b-a4cf-66bb4f697f17"    },    "requestId": "abe50236-cf30-435f-b7fc-c05cb8f0f320"
 }

resource.ResourceUpdated#

A resource updated event is emitted when a resource is changed.

Property	Type
`uuid`	UUID
`resource`
`user`
`_id`	string
`timestamp`	timestamp
`requestId`	string

Example event#

{    "event": "resource.ResourceUpdated",    "uuid": "8f2792c7-b01a-4493-ba5a-d0588a4aad8e",    "resource": {        "type": "custom.Resource",        ...    }    "user": {        "id": "00b82755-b5e6-4c8b-a4cf-66bb4f697f17"    },    "requestId": "abe50236-cf30-435f-b7fc-c05cb8f0f320"
 }

resource.ResourceSoftDeleted#

A resource soft deleted event is emitted if a resource is marked for deletion but not yet permanently deleted.

Typically, a resource.ResourceHardDeleted event will follow a resource.ResourceSoftDeleted event. However, not all services support soft delete and in this case, only a resource.ResourceHardDeleted is emitted.

Property	Type
`uuid`	UUID
`resource`
`user`
`_id`	string
`timestamp`	timestamp
`requestId`	string

Example event#

{    "event": "resource.ResourceSoftDeleted",    "uuid": "8f2792c7-b01a-4493-ba5a-d0588a4aad8e",    "resource": {        "type": "custom.Resource",        ...    }    "user": {        "id": "00b82755-b5e6-4c8b-a4cf-66bb4f697f17"    },    "requestId": "abe50236-cf30-435f-b7fc-c05cb8f0f320"
 }

resource.ResourceHardDeleted#

A resource hard deleted event is emitted if a resource is deleted permanently. This means is it either deleted with ?purge=true or otherwise deleted in a way that means it cannot be recovered.

Property	Type
`uuid`	UUID
`resource`
`user`
`_id`	string
`timestamp`	timestamp
`requestId`	string

Example event#

{    "event": "resource.ResourceHardDeleted",    "uuid": "8f2792c7-b01a-4493-ba5a-d0588a4aad8e",    "resource": {        "type": "custom.Resource",        ...    }    "user": {        "id": "00b82755-b5e6-4c8b-a4cf-66bb4f697f17"    },    "requestId": "abe50236-cf30-435f-b7fc-c05cb8f0f320"
 }

Item Service resource types#

This section lists the resource types which are specific to the Item Service.

itemsvc.NamedCompositeItem#

Object	Property	Type
`resource`
	`id`	string
	`namespaces`	string[]
	`userItemid`	string
`before`
	`name`	string
	`description`	string
	`userType`	string
	`shortName`	string
	`itemClass`	string
	`kind`	string
	`namespaces`	string[]
	`tipVersion`	integer
`after`
	`name`	string
	`description`	string
	`userType`	string
	`shortName`	string
	`itemClass`	string
	`kind`	string
	`namespaces`	string[]
	`tipVersion`	integer

itemsvc.NamedCompositeItemVersion#

Object	Property	Type
`resource`
	`id`	string
	`namespaces`	string[]
	`userItemDbld`	string
	`userItemId`	string
	`version`	integer
`before`
	`namespaces`	string[]
	`userItemDbld`	string
	`userItemId`	string
	`userType`	string
	`shortName`	string
	`itemClass`	string
	`kind`	string
	`namespaces`	string[]
	`tipVersion`	integer
`after`
	`namespaces`	string[]
	`userItemDbld`	string
	`userItemId`	string
	`userType`	string
	`shortName`	string
	`itemClass`	string
	`kind`	string
	`namespaces`	string[]
	`tipVersion`	integer

itemsvc.NamedTelemetryCollectionVersion#

Object	Property	Type
`resource`
	`id`	string
	`namespaces`	string[]
	`userItemDbld`	string
	`userItemId`	string
	`version`	integer
`before`
	`namespaces`	string[]
	`userItemDbld`	string
	`userItemId`	string
	`itemClass`	string
	`version`	integer
`after`
	`namespaces`	string[]
	`userItemDbld`	string
	`userItemId`	string
	`itemClass`	string
	`version`	integer

itemsvc.NamedUserCollection#

Object	Property	Type
`resource`
	`id`	string
	`namespaces`	string[]
	`userItemId`	string
`before`
	`name`	string
	`description`	string
	`userType`	string
	`shortName`	string
	`itemClass`	string
	`kind`	string
	`namespaces`	string[]
	`tipversion`	integer
`after`
	`name`	string
	`description`	string
	`userType`	string
	`shortName`	string
	`itemClass`	string
	`kind`	string
	`namespaces`	string[]
	`tipversion`	integer

itemsvc.NamedUserCollectionVersion#

Object	Property	Type
`resource`
	`id`	string
	`namespaces`	string[]
	`userItemDbId`	string
	`userItemId`	string
	`version`	integer
`before`
	`namespaces`	string[]
	`userItemDbld`	string
	`userItemId`	string
	`itemClass`	string
	`version`	integer
`after`
	`namespaces`	string[]
	`userItemDbld`	string
	`userItemId`	string
	`itemClass`	string
	`version`	integer

itemsvc.SchemaDefinition#

Object	Property	Type
`resource`
	`id`	string
	`namespaces`	string[]
`before`
	`name`	string
	`description`	string
	`userType`	string
	`shortName`	string
	`definition`	string
	`namespaces`	string[]
`after`
	`name`	string
	`description`	string
	`userType`	string
	`shortName`	string
	`definition`	string
	`namespaces`	string[]

itemsvc.Script#

Object	Property	Type
`resource`
	`id`	string
	`namespaces`	string[]
	`userItemId`	string
`before`
	`name`	string
	`description`	string
	`userType`	string
	`shortName`	string
	`itemClass`	string
	`kind`	string
	`namespaces`	string[]
	`tipVersion`	integer
`after`
	`name`	string
	`description`	string
	`userType`	string
	`shortName`	string
	`itemClass`	string
	`kind`	string
	`namespaces`	string[]
	`tipVersion`	integer

itemsvc.ScriptVersion#

Object	Property	Type
`resource`
	`id`	string
	`namespaces`	string[]
	`userItemDbId`	string
	`userItemId`	string
	`version`	integer
`before`
	`namespaces`	string[]
	`userItemDbId`	string
	`userItemId`	string
	`itemClass`	string
	`version`	integer
`after`
	`namespaces`	string[]
	`userItemDbId`	string
	`userItemId`	string
	`itemClass`	string
	`version`	integer

itemsvc.UserConfig#

Object	Property	Type
`resource`
	`id`	string
	`namespaces`	string[]
	`userItemId`	string
`before`
	`name`	string
	`description`	string
	`userType`	string
	`shortName`	string
	`itemClass`	string
	`kind`	string
	`namespaces`	string[]
	`tipVersion`	integer
`after`
	`name`	string
	`description`	string
	`userType`	string
	`shortName`	string
	`itemClass`	string
	`kind`	string
	`namespaces`	string[]
	`tipVersion`	integer

itemsvc.UserConfigVersion#

Object	Property	Type
`resource`
	`id`	string
	`namespaces`	string[]
	`userItemDbId`	string
	`userItemId`	string
	`version`	integer
`before`
	`namespaces`	string[]
	`userItemDbId`	string
	`userItemId`	string
	`itemClass`	string
	`version`	integer
`after`
	`namespaces`	string[]
	`userItemDbId`	string
	`userItemId`	string
	`itemClass`	string
	`version`	integer