Asset SDK

A physical or digital asset that is tracked, managed, or utilized in business operations. Assets can be identified using GS1 identifiers (GIAI for individual assets, GRAI for returnable assets) for global traceability.

Import

import { $ } from 'sdk.do'

Operations

create

const result = await $.Asset.create({
  // parameters
})

update

Update asset information or status.

const result = await $.Asset.update({
  // parameters
})

delete

Remove an asset from tracking (decommissioning).

const result = await $.Asset.delete({
  // parameters
})

assign

Assign the asset to a person, location, or entity.

const result = await $.Asset.assign({
  // parameters
})

transfer

Transfer ownership or custody of the asset.

const result = await $.Asset.transfer({
  // parameters
})

locate

Update the current location of the asset.

const result = await $.Asset.locate({
  // parameters
})

maintain

Record maintenance performed on the asset.

const result = await $.Asset.maintain({
  // parameters
})

inspect

Record inspection results for the asset.

const result = await $.Asset.inspect({
  // parameters
})

depreciate

Calculate and record depreciation.

const result = await $.Asset.depreciate({
  // parameters
})

retire

Mark the asset as retired or disposed.

const result = await $.Asset.retire({
  // parameters
})

Events

created

Triggered when a new asset is registered in the system.

import { on, send } from 'sdk.do'

// Subscribe to event
on.Asset.created(async (data) => {
  console.log('Event received:', data)
})

// Emit event
await send.Asset.created({ /* data */ })

updated

Triggered when asset information is modified.

import { on, send } from 'sdk.do'

// Subscribe to event
on.Asset.updated(async (data) => {
  console.log('Event received:', data)
})

// Emit event
await send.Asset.updated({ /* data */ })

deleted

Triggered when an asset is decommissioned or removed.

import { on, send } from 'sdk.do'

// Subscribe to event
on.Asset.deleted(async (data) => {
  console.log('Event received:', data)
})

// Emit event
await send.Asset.deleted({ /* data */ })

assigned

Triggered when the asset is assigned to someone or something.

import { on, send } from 'sdk.do'

// Subscribe to event
on.Asset.assigned(async (data) => {
  console.log('Event received:', data)
})

// Emit event
await send.Asset.assigned({ /* data */ })

transferred

Triggered when ownership or custody changes.

import { on, send } from 'sdk.do'

// Subscribe to event
on.Asset.transferred(async (data) => {
  console.log('Event received:', data)
})

// Emit event
await send.Asset.transferred({ /* data */ })

located

Triggered when the asset's location is updated.

import { on, send } from 'sdk.do'

// Subscribe to event
on.Asset.located(async (data) => {
  console.log('Event received:', data)
})

// Emit event
await send.Asset.located({ /* data */ })

maintained

Triggered when maintenance is performed.

import { on, send } from 'sdk.do'

// Subscribe to event
on.Asset.maintained(async (data) => {
  console.log('Event received:', data)
})

// Emit event
await send.Asset.maintained({ /* data */ })

inspected

Triggered when an inspection is completed.

import { on, send } from 'sdk.do'

// Subscribe to event
on.Asset.inspected(async (data) => {
  console.log('Event received:', data)
})

// Emit event
await send.Asset.inspected({ /* data */ })

depreciated

Triggered when depreciation is calculated.

import { on, send } from 'sdk.do'

// Subscribe to event
on.Asset.depreciated(async (data) => {
  console.log('Event received:', data)
})

// Emit event
await send.Asset.depreciated({ /* data */ })

retired

Triggered when the asset is retired from service.

import { on, send } from 'sdk.do'

// Subscribe to event
on.Asset.retired(async (data) => {
  console.log('Event received:', data)
})

// Emit event
await send.Asset.retired({ /* data */ })

lost

Triggered when the asset cannot be located.

import { on, send } from 'sdk.do'

// Subscribe to event
on.Asset.lost(async (data) => {
  console.log('Event received:', data)
})

// Emit event
await send.Asset.lost({ /* data */ })

found

Triggered when a lost asset is recovered.

import { on, send } from 'sdk.do'

// Subscribe to event
on.Asset.found(async (data) => {
  console.log('Event received:', data)
})

// Emit event
await send.Asset.found({ /* data */ })

damaged

Triggered when damage to the asset is reported.

import { on, send } from 'sdk.do'

// Subscribe to event
on.Asset.damaged(async (data) => {
  console.log('Event received:', data)
})

// Emit event
await send.Asset.damaged({ /* data */ })

Asset SDK

On this page