logo
API docs by Redocly

moneo api (1.0)

Download OpenAPI specification:

The moneo API provides a standardized cloud interface for integrating external systems with the ifm IIoT platform moneo. Typical integrations include ERP, BI and analytics tools, MES, SCADA and third-party applications. The API exposes multiple endpoints for managing and retrieving moneo-related data.

This documentation currently covers two main APIs:

moneo Platform API
The moneo Platform API provides endpoints for retrieving historical process data, managing tickets, and accessing topology information. Built for security and scalability, it supports token-based authentication as well as flexible queries with filtering and sorting options.

moneo Track & Trace API
The moneo Track & Trace API focuses on traceability and logistics data integration. It offers endpoints for real-time access to tracking information, supporting transparency across production and intralogistics processes.


Authentication and Rate Limiting Information
All endpoints require Bearer authentication using Personal Access Tokens (PAT). Each token inherits the permissions of the user who created it. For guidance on creating and managing PATs, please refer to the moneo|Help documentation.

To ensure fair usage and maintain optimal performance, the API enforces rate limiting. Clients are allowed a maximum of 100 requests per minute per endpoint. Exceeding this limit will result in a 429 Too Many Requests response. It is recommended to implement retry logic with exponential backoff in your client applications to handle rate limit responses gracefully. The limit is based on the moneo instance and applies to all users and tokens collectively.

Tickets

Endpoints for updating tickets related to system events and issues.

Updates a ticket

Changes the content (e.g. state) of a ticket

path Parameters
ticketId
required
string <uuid> <= 36 characters
Example: c77cbdd6-a17a-4a26-9d43-2fffc8887963

ID of the ticket

Request Body schema: application/json
state
string
Enum: "accepted" "closed"

Represents the current state of the ticket

Responses

Request samples

Content type
application/json
{
  • "state": "accepted"
}

Response samples

Content type
application/problem+json
{
  • "title": "Invalid Ticket State",
  • "status": 400,
  • "detail": "The provided state transition is not allowed."
}

Process Data

This endpoint provides historical process data for a particular data source from a particular device.

Get process data

Gets process data for a datasource of a device

path Parameters
deviceId
required
string <uuid> <= 36 characters
Example: d8f3f705-02b9-47d1-8bf9-d239a12d9e3d

ID of the device

datasourceId
required
string <= 150 characters ^[a-z0-9-_]*$
Example: temperature

ID of the datasource

query Parameters
fromTimestamp
integer <int64> [ 0 .. 9223372036854776000 ]
Example: fromTimestamp=17301790441474

Filters the result by a minimum start timestamp (unix timestamp in milliseconds in UTC). Including the provided fromTimestamp.

toTimestamp
integer <int64> [ 0 .. 9223372036854776000 ]
Example: toTimestamp=17301790451474

Filters the result by a maximum end timestamp (unix timestamp in milliseconds in UTC). Including the provided toTimestamp.

orderBy
Array of strings <= 1 items
Default: "-timestamp"
Items Enum: "+timestamp" "-timestamp"
Example: orderBy=+timestamp

Defines the sorting of the result. The prefix '-' represents a descending sorting of the property, no indication or '+' leads to an ascending sorting.

pageNumber
integer <int32> [ 0 .. 9223372036854776000 ]
Default: 1
pageSize
integer <int32> [ 0 .. 9223372036854776000 ]
Default: 500

Responses

Response Schema: application/json
pageNumber
integer <int32> [ 0 .. 9223372036854776000 ]
Default: 1

Represents the current page number

pageSize
integer <int32> [ 0 .. 1000 ]
Default: 1

Represents the size of the page

totalPages
integer <int32> [ 0 .. 9223372036854776000 ]

Represents the total pages

totalCount
integer <int32> [ 0 .. 9223372036854776000 ]

Represents the total amount of the ressource

Array of objects (processdata) <= 1000 items

Data of the current request

Array (<= 1000 items)
timestamp
integer <int64> [ 0 .. 9223372036854776000 ]

Unix timestamp (UTC) in milliseconds

value
number

Sensor value

Response samples

Content type
application/json
{
  • "totalCount": 2,
  • "pageNumber": 1,
  • "pageSize": 500,
  • "items": [
    • {
      },
    • {
      }
    ]
}

Nodes

The topology serves as a structural element between devices and data sources in moneo. This endpoint can be used to query the topology and use it as a structural element in external systems.

Gets the topology nodes

Gets the available topology nodes

query Parameters
ids
Array of strings <uuid> <= 500 items [ items <uuid > <= 36 characters ]
Example: ids=fa2936a7-b27a-4395-9b8e-f323635791ec,fce412c8-7e04-4be3-b2bd-5bcca075ec4b

Array of requested ids which should be used as a filter

categories
Array of strings <= 5 items
Items Enum: "root" "functionalLocation" "device" "dataSource" "calcDataSource"
Example: categories=root,functionalLocation

Array of requested categories which should be used as a filter

orderBy
Array of strings <= 1 items
Items Enum: "+name" "-name"
Example: orderBy=+name

Defines the sorting of the result. The prefix '-' represents a descending sorting of the property, no indication or '+' leads to an ascending sorting.

pageNumber
integer <int32> [ 1 .. 2147483647 ]
Default: 1
pageSize
integer <int32> [ 1 .. 2147483647 ]
Default: 500

Responses

Response Schema: application/json
pageNumber
integer <int32> [ 1 .. 2147483647 ]
Default: 1

page number

pageSize
integer <int32> [ 1 .. 2147483647 ]
Default: 1

page size

totalPages
integer <int32> [ 1 .. 2147483647 ]

total pages

totalCount
integer <int32> [ 1 .. 2147483647 ]

total amount of found nodes

Array of objects (topologyNode) <= 2147483647 items

data of result, containing topology nodes

Array (<= 2147483647 items)
id
string <uuid> <= 36 characters

id of node

parentNodeId
string <uuid> <= 36 characters

id of parent node

name
string <= 255 characters ^[A-Za-z0-9]+$

name of node

hasChildren
boolean

true if node has children

category
string
Enum: "root" "functionalLocation" "device" "dataSource" "calcDataSource"

type of node

object or object

reference to the device or datasource

One of
deviceId
string <uuid> <= 36 characters

id of referenced device

Response samples

Content type
application/json
{
  • "totalCount": 2,
  • "pageNumber": 1,
  • "pageSize": 500,
  • "items": [
    • {
      },
    • {
      }
    ]
}

Attributes

Attributes are custom information to describe items in more detail (e.g. production order number, material number).

Gets all Attributes

Gets all available Attributes with filtering, sorting and pagination options.

query Parameters
names
Array of strings
ids
Array of strings <uuid> [ items <uuid > ]
globalVariableTypes
Array of strings (GlobalVariableType)
Items Enum: "String" "Integer" "Double"
activated
boolean
properties
Array of strings (GlobalVariableProperty)
Items Enum: "GlobalVariableId" "Name" "Description" "GlobalVariableType" "Activated"
orderBy
string
pageNumber
integer <int32>
pageSize
integer <int32>

Responses

Response Schema: application/json
pageNumber
integer <int32>
pageSize
integer <int32>
totalPages
integer <int32>
totalCount
integer <int32>
Array of objects or null (HttpLink)
Array
rel
string (HttpRel)
Enum: "Next" "Prev"
href
string or null
Array of objects or null (GlobalVariableViewModel)
Array
globalVariableId
string <uuid>
name
string or null
description
string or null
globalVariableType
string (GlobalVariableType)
Enum: "String" "Integer" "Double"
activated
boolean

Response samples

Content type
application/json
{
  • "totalCount": 2,
  • "pageNumber": 1,
  • "pageSize": 10,
  • "data": [
    • {
      },
    • {
      }
    ]
}

Adds new Attributes

Adds new Attributes to the system.

Request Body schema:
Array of objects or null (GlobalVariablesDto)
Array
name
string or null
description
string or null
type
string (GlobalVariableType)
Enum: "String" "Integer" "Double"
activated
boolean

Responses

Response Schema: application/json
Array
globalVariableId
string <uuid>
name
string or null
description
string or null
globalVariableType
string (GlobalVariableType)
Enum: "String" "Integer" "Double"
activated
boolean

Request samples

Content type
{
  • "globalVariables": [
    • {
      }
    ]
}

Response samples

Content type
application/json
[
  • {
    • "globalVariableId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    • "name": "Temperature",
    • "description": "test",
    • "globalVariableType": "Double",
    • "activated": true
    }
]

Stations

Stations represent the physical location or process step within a tracking layout. They can contain items.

Get a list of Items in specific Station

Gets the current Items located in the specified Station with pagination support.

path Parameters
stationId
required
string <uuid>
Example: d290f1ee-6c54-4b01-90e6-d701748f0851
query Parameters
pageNumber
integer <int32>
pageSize
integer <int32>

Responses

Response Schema: application/json
pageNumber
integer <int32>
pageSize
integer <int32>
totalPages
integer <int32>
totalCount
integer <int32>
Array of objects or null (HttpLink)
Array
rel
string (HttpRel)
Enum: "Next" "Prev"
href
string or null
Array of objects or null (ItemViewModel)
Array
id
integer <int64>
object (UniqueIdentifier)
value
string <uuid>
itemId
string or null
object (ItemTypeViewModel)
itemTypeId
integer <int32>
object (ItemSequenceViewModel)
itemSequenceId
integer <int64>
identStationId
string <uuid>
identStationName
string or null
entryTime
string <date-time>
exitTime
string or null <date-time>
durationInSeconds
integer or null <int32>
manuallyTriggeredEntryByUserId
string or null <uuid>
object (MoneoUserViewModel)
manuallyTriggeredExitByUserId
string or null <uuid>
object (MoneoUserViewModel)
Array of objects or null (ItemSequenceDataViewModel)
object (ItemSequenceQualityDataViewModel)
object (ItemSequenceViewModel)
itemSequenceId
integer <int64>
identStationId
string <uuid>
identStationName
string or null
entryTime
string <date-time>
exitTime
string or null <date-time>
durationInSeconds
integer or null <int32>
manuallyTriggeredEntryByUserId
string or null <uuid>
object (MoneoUserViewModel)
manuallyTriggeredExitByUserId
string or null <uuid>
object (MoneoUserViewModel)
Array of objects or null (ItemSequenceDataViewModel)
object (ItemSequenceQualityDataViewModel)
Array of objects or null (ItemVariableRelationViewModel)
Array
globalVariableId
string <uuid>
value
string or null
state
string (ItemVariableRelationState)
Enum: "Attached" "Detached"
globalVariableName
string or null
globalVariableType
string (GlobalVariableType)
Enum: "String" "Integer" "Double"

Response samples

Content type
application/json
{
  • "totalCount": 2,
  • "pageNumber": 1,
  • "pageSize": 10,
  • "data": [
    • {
      },
    • {
      }
    ]
}

Gets the last item in and out of given station

Gets the last items that have passed through the given station, with options to filter.

path Parameters
stationId
required
string <uuid>

Station id

query Parameters
itemsInProcess
boolean

If wanted items are in process

amount
integer <int32>

Amount of items, max 25

Responses

Response Schema: application/json
Array
id
integer <int64>
object (UniqueIdentifier)
value
string <uuid>
itemId
string or null
object (ItemTypeViewModel)
itemTypeId
integer <int32>
object (ItemSequenceViewModel)
itemSequenceId
integer <int64>
identStationId
string <uuid>
identStationName
string or null
entryTime
string <date-time>
exitTime
string or null <date-time>
durationInSeconds
integer or null <int32>
manuallyTriggeredEntryByUserId
string or null <uuid>
object (MoneoUserViewModel)
moneoUserId
string <uuid>
firstName
string or null
lastName
string or null
manuallyTriggeredExitByUserId
string or null <uuid>
object (MoneoUserViewModel)
moneoUserId
string <uuid>
firstName
string or null
lastName
string or null
Array of objects or null (ItemSequenceDataViewModel)
Array
itemSequenceDataId
integer <int64>
itemSequenceId
integer <int64>
moneoThingWithPropertyId
string <uuid>
moneoThingWithPropertyUniqueIdentifier
string or null
moneoThingWithPropertyTopologyNodeId
string <uuid>
entryValue
string or null
entryTimestamp
string <date-time>
exitValue
string or null
exitTimestamp
string <date-time>
durationMinValue
number or null <double>
durationMinValueTimestamp
string <date-time>
durationMaxValue
number or null <double>
durationMaxValueTimestamp
string <date-time>
durationAverageValue
number or null <double>
state
string (ItemSequenceDataState)
Enum: "Pending" "Done" "Aborted"
customName
string or null
recordingType
integer <int32>
object (ItemSequenceQualityDataViewModel)
itemSequenceQualityDataId
integer <int64>
itemSequenceId
integer <int64>
moneoThingWithPropertyId
string <uuid>
moneoThingWithPropertyUniqueIdentifier
string or null
value
number or null <double>
timeStamp
string <date-time>
object (ItemSequenceQualityDataSettingsViewModel)
qualityResult
string (Quality)
Enum: "Invalid" "Pass" "Fail" "Scrap" "NotAvailable"
state
string (ItemSequenceDataState)
Enum: "Pending" "Done" "Aborted"
object (ItemSequenceViewModel)
itemSequenceId
integer <int64>
identStationId
string <uuid>
identStationName
string or null
entryTime
string <date-time>
exitTime
string or null <date-time>
durationInSeconds
integer or null <int32>
manuallyTriggeredEntryByUserId
string or null <uuid>
object (MoneoUserViewModel)
moneoUserId
string <uuid>
firstName
string or null
lastName
string or null
manuallyTriggeredExitByUserId
string or null <uuid>
object (MoneoUserViewModel)
moneoUserId
string <uuid>
firstName
string or null
lastName
string or null
Array of objects or null (ItemSequenceDataViewModel)
Array
itemSequenceDataId
integer <int64>
itemSequenceId
integer <int64>
moneoThingWithPropertyId
string <uuid>
moneoThingWithPropertyUniqueIdentifier
string or null
moneoThingWithPropertyTopologyNodeId
string <uuid>
entryValue
string or null
entryTimestamp
string <date-time>
exitValue
string or null
exitTimestamp
string <date-time>
durationMinValue
number or null <double>
durationMinValueTimestamp
string <date-time>
durationMaxValue
number or null <double>
durationMaxValueTimestamp
string <date-time>
durationAverageValue
number or null <double>
state
string (ItemSequenceDataState)
Enum: "Pending" "Done" "Aborted"
customName
string or null
recordingType
integer <int32>
object (ItemSequenceQualityDataViewModel)
itemSequenceQualityDataId
integer <int64>
itemSequenceId
integer <int64>
moneoThingWithPropertyId
string <uuid>
moneoThingWithPropertyUniqueIdentifier
string or null
value
number or null <double>
timeStamp
string <date-time>
object (ItemSequenceQualityDataSettingsViewModel)
qualityResult
string (Quality)
Enum: "Invalid" "Pass" "Fail" "Scrap" "NotAvailable"
state
string (ItemSequenceDataState)
Enum: "Pending" "Done" "Aborted"
Array of objects or null (ItemVariableRelationViewModel)
Array
globalVariableId
string <uuid>
value
string or null
state
string (ItemVariableRelationState)
Enum: "Attached" "Detached"
globalVariableName
string or null
globalVariableType
string (GlobalVariableType)
Enum: "String" "Integer" "Double"

Response samples

Content type
application/json
[
  • {
    • "id": 789
    },
  • {
    • "id": 101
    }
]

Gets all stations

Gets all available stations with filtering, sorting and pagination options.

query Parameters
ids
Array of strings <uuid> [ items <uuid > ]
names
Array of strings
activated
boolean
layoutIds
Array of strings <uuid> [ items <uuid > ]
topologyNodeIds
Array of strings <uuid> [ items <uuid > ]
properties
Array of strings (GetIdentStationProperty)
Items Enum: "IdentStationId" "Name" "Description" "Activated" "RunMode" "IdentStationTemplateId" "TopologyNodeId"
orderBy
string
pageNumber
integer <int32>
pageSize
integer <int32>

Responses

Response Schema: application/json
pageNumber
integer <int32>
pageSize
integer <int32>
totalPages
integer <int32>
totalCount
integer <int32>
Array of objects or null (HttpLink)
Array
rel
string (HttpRel)
Enum: "Next" "Prev"
href
string or null
Array of objects or null (IdentStationViewModel)
Array
identStationId
string <uuid>
name
string or null
description
string or null
activated
boolean
runMode
string (IdentStationRunMode)
Enum: "Prod" "Demo"
identStationTemplateId
string <uuid>
topologyNodeId
string <uuid>

Response samples

Content type
application/json
{
  • "totalCount": 2,
  • "pageNumber": 1,
  • "pageSize": 10,
  • "data": [
    • {
      },
    • {
      }
    ]
}

Get specific Stations

Gets detailed information about a specific identification station by its unique identifier.

path Parameters
stationId
required
string <uuid>

Responses

Response Schema: application/json
identStationId
string <uuid>
identStationName
string or null
identStationDescription
string or null
identStationActivated
boolean
createdByUserId
string <uuid>
object (MoneoUserViewModel)
moneoUserId
string <uuid>
firstName
string or null
lastName
string or null
createdAtTimestamp
string <date-time>
editedByUserId
string <uuid>
object (MoneoUserViewModel)
moneoUserId
string <uuid>
firstName
string or null
lastName
string or null
editedAtTimestamp
string or null <date-time>
Array of objects or null (TriggerThingViewModel)
Array
identStationTriggerThingId
string <uuid>
object (MoneoThingWithPropertyViewModel)
thingId
string <uuid>
uniqueIdentifier
string or null
displayName
string or null
topologyNodeId
string <uuid>
triggerThingType
string (IdentStationTriggerThingType)
Enum: "In" "Out" "InOut" "Garage"
garageDelayInSeconds
integer <int32>
Array of objects or null (IdentRuleRelationViewModel)
Array
identRuleRelationId
string <uuid>
identStationId
string <uuid>
failActivityId
string <uuid>
identRuleId
string <uuid>
object (IdentRuleActivityViewModel)
identRuleActivityId
string <uuid>
nameTranslationKey
string or null
descriptionTranslationKey
string or null
activityType
string (IdentRuleActivityType)
Enum: "Stop" "Pass"
object (IdentRuleViewModel)
identRuleId
string <uuid>
nameTranslationKey
string or null
descriptionTranslationKey
string or null
identRuleType
string (IdentRuleType)
Enum: "In" "Out" "Scheduled"
activated
boolean
order
integer <int32>
ruleOptions
string or null
Array of objects or null (IdentRuleRelationViewModel)
Array
identRuleRelationId
string <uuid>
identStationId
string <uuid>
failActivityId
string <uuid>
identRuleId
string <uuid>
object (IdentRuleActivityViewModel)
identRuleActivityId
string <uuid>
nameTranslationKey
string or null
descriptionTranslationKey
string or null
activityType
string (IdentRuleActivityType)
Enum: "Stop" "Pass"
object (IdentRuleViewModel)
identRuleId
string <uuid>
nameTranslationKey
string or null
descriptionTranslationKey
string or null
identRuleType
string (IdentRuleType)
Enum: "In" "Out" "Scheduled"
activated
boolean
order
integer <int32>
ruleOptions
string or null
Array of objects or null (IdentRuleRelationViewModel)
Array
identRuleRelationId
string <uuid>
identStationId
string <uuid>
failActivityId
string <uuid>
identRuleId
string <uuid>
object (IdentRuleActivityViewModel)
identRuleActivityId
string <uuid>
nameTranslationKey
string or null
descriptionTranslationKey
string or null
activityType
string (IdentRuleActivityType)
Enum: "Stop" "Pass"
object (IdentRuleViewModel)
identRuleId
string <uuid>
nameTranslationKey
string or null
descriptionTranslationKey
string or null
identRuleType
string (IdentRuleType)
Enum: "In" "Out" "Scheduled"
activated
boolean
order
integer <int32>
ruleOptions
string or null
object (IdentRuleActivityViewModel)
identRuleActivityId
string <uuid>
nameTranslationKey
string or null
descriptionTranslationKey
string or null
activityType
string (IdentRuleActivityType)
Enum: "Stop" "Pass"
object (IdentRuleActivityViewModel)
identRuleActivityId
string <uuid>
nameTranslationKey
string or null
descriptionTranslationKey
string or null
activityType
string (IdentRuleActivityType)
Enum: "Stop" "Pass"
object (IdentStationSetupViewModel)
identStationSetupId
string <uuid>
name
string or null
description
string or null
activated
boolean
createdAtTimestamp
string <date-time>
deletable
boolean
identStationRunMode
string (IdentStationRunMode)
Enum: "Prod" "Demo"
identStationTemplateId
string <uuid>
itemConfigurationId
string or null <uuid>
layoutId
string or null <uuid>
topologyNodeId
string or null <uuid>
object (IdentStationSignalThingViewModel)
identStationSignalThingId
string <uuid>
triggerSignalWhenSuccess
boolean
triggerSignalWhenFailed
boolean
durationForSignalInSeconds
integer <int32>
moneoThingId
string <uuid>
segmentType
string (IdentStationSignalThingSegmentType)
Enum: "OneSegment" "ThreeSegment" "FiveSegment"
object (TriggerSignalOptionViewModel)
triggerSignalOptionId
string <uuid>
segmentNumber
string (SegmentNumber)
Enum: "SegmentOne" "SegmentTwo" "SegmentThree" "SegmentFour" "SegmentFive"
segmentColor
string (SegmentColor)
Enum: "Off" "Red" "Green" "Amber" "Blue" "Purple" "Cyan" "White" "Yellow"
signalFunction
string (SignalFunction)
Enum: "Continuous" "BlinkingSlow" "BlinkingMiddle" "BlinkingFast" "FlashingSlow" "FlashingMiddle" "FlashingFast"
signalBuzzer
string (SignalBuzzer)
Enum: "Off" "RapidIntermittentBeep" "RapidHiLo" "Sweep" "ContBeepOnOff" "RapidBeepOnOff" "RapidHiLoOnOff" "SweepOnOff"
object (TriggerSignalOptionViewModel)
triggerSignalOptionId
string <uuid>
segmentNumber
string (SegmentNumber)
Enum: "SegmentOne" "SegmentTwo" "SegmentThree" "SegmentFour" "SegmentFive"
segmentColor
string (SegmentColor)
Enum: "Off" "Red" "Green" "Amber" "Blue" "Purple" "Cyan" "White" "Yellow"
signalFunction
string (SignalFunction)
Enum: "Continuous" "BlinkingSlow" "BlinkingMiddle" "BlinkingFast" "FlashingSlow" "FlashingMiddle" "FlashingFast"
signalBuzzer
string (SignalBuzzer)
Enum: "Off" "RapidIntermittentBeep" "RapidHiLo" "Sweep" "ContBeepOnOff" "RapidBeepOnOff" "RapidHiLoOnOff" "SweepOnOff"
Array of objects or null (IdentStationProcessDataSourceViewModel)
Array
object (MoneoThingWithPropertyViewModel)
thingId
string <uuid>
uniqueIdentifier
string or null
displayName
string or null
topologyNodeId
string <uuid>
recordingType
integer <int32>
customName
string or null
itemSequenceQualityDataSettingsId
integer or null <int64>
object (ItemSequenceQualityDataSettingsViewModel)
itemSequenceQualityDataSettingsId
integer <int64>
object (QualitySetting)
referenceId
string or null

Response samples

Content type
application/json
{
  • "identStationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  • "identStationName": "Station 1",
  • "identStationDescription": "Beschreibung der Station",
  • "identStationActivated": true,
  • "createdByUserId": "b2c3d4e5-f678-90ab-cdef-1234567890ab",
  • "createdByUser": {
    • "moneoUserId": "b2c3d4e5-f678-90ab-cdef-1234567890ab",
    • "firstName": "Max",
    • "lastName": "Mustermann"
    },
  • "createdAtTimestamp": "2024-06-13T10:00:00Z",
  • "editedByUserId": "c3d4e5f6-7890-abcd-ef12-34567890abcd",
  • "editedByUser": {
    • "moneoUserId": "c3d4e5f6-7890-abcd-ef12-34567890abcd",
    • "firstName": "Erika",
    • "lastName": "Musterfrau"
    },
  • "editedAtTimestamp": null,
  • "pipelineTriggerThings": [ ],
  • "inPipelineIdentRuleRelations": null,
  • "outPipelineIdentRuleRelations": null,
  • "scheduledPipelineIdentRuleRelations": null,
  • "inPipelineIdentRulePassActivity": { },
  • "outPipelineIdentRulePassActivity": { },
  • "identStationSetup": { },
  • "identStationRunMode": "Prod",
  • "identStationTemplateId": "d4e5f678-90ab-cdef-1234-567890abcdef",
  • "itemConfigurationId": null,
  • "layoutId": null,
  • "topologyNodeId": null,
  • "signalThing": { },
  • "processDataSources": null,
  • "referenceId": null
}

Items

Items are unique entities that represent, for example, a semi-finished product, a product, a material, a workpiece carrier, or a reusable load carrier (e.g. special rack, IBC, or plastic box).

Gets the sequences of the given item

Gets the sequences assigned to the given item with filtering and pagination options.

Authorizations:
bearerPatAuth
path Parameters
itemId
required
string

Item id

query Parameters
properties
Array of strings (ItemSequenceProperty)
Items Enum: "IdentStationId" "IdentStationName" "EntryTime" "ExitTime" "DurationInSeconds"

Optional properties to shape result

pageNumber
integer <int32>
pageSize
integer <int32>

Responses

Response Schema: application/json
pageNumber
integer <int32>
pageSize
integer <int32>
totalPages
integer <int32>
totalCount
integer <int32>
Array of objects or null (HttpLink)
Array
rel
string (HttpRel)
Enum: "Next" "Prev"
href
string or null
Array of objects or null (ItemSequenceViewModel)
Array
itemSequenceId
integer <int64>
identStationId
string <uuid>
identStationName
string or null
entryTime
string <date-time>
exitTime
string or null <date-time>
durationInSeconds
integer or null <int32>
manuallyTriggeredEntryByUserId
string or null <uuid>
object (MoneoUserViewModel)
moneoUserId
string <uuid>
firstName
string or null
lastName
string or null
manuallyTriggeredExitByUserId
string or null <uuid>
object (MoneoUserViewModel)
moneoUserId
string <uuid>
firstName
string or null
lastName
string or null
Array of objects or null (ItemSequenceDataViewModel)
Array
itemSequenceDataId
integer <int64>
itemSequenceId
integer <int64>
moneoThingWithPropertyId
string <uuid>
moneoThingWithPropertyUniqueIdentifier
string or null
moneoThingWithPropertyTopologyNodeId
string <uuid>
entryValue
string or null
entryTimestamp
string <date-time>
exitValue
string or null
exitTimestamp
string <date-time>
durationMinValue
number or null <double>
durationMinValueTimestamp
string <date-time>
durationMaxValue
number or null <double>
durationMaxValueTimestamp
string <date-time>
durationAverageValue
number or null <double>
state
string (ItemSequenceDataState)
Enum: "Pending" "Done" "Aborted"
customName
string or null
recordingType
integer <int32>
object (ItemSequenceQualityDataViewModel)
itemSequenceQualityDataId
integer <int64>
itemSequenceId
integer <int64>
moneoThingWithPropertyId
string <uuid>
moneoThingWithPropertyUniqueIdentifier
string or null
value
number or null <double>
timeStamp
string <date-time>
object (ItemSequenceQualityDataSettingsViewModel)
qualityResult
string (Quality)
Enum: "Invalid" "Pass" "Fail" "Scrap" "NotAvailable"
state
string (ItemSequenceDataState)
Enum: "Pending" "Done" "Aborted"

Response samples

Content type
application/json
{
  • "totalCount": 2,
  • "pageNumber": 1,
  • "pageSize": 10,
  • "data": [
    • {
      },
    • {
      }
    ]
}

Gets the global variables on given item

Gets the global variables assigned to the given item with filtering and pagination options.

Authorizations:
bearerPatAuth
path Parameters
itemId
required
string

Item id

query Parameters
properties
Array of strings (ItemVariableRelationProperty)
Items Enum: "GlobalVariableId" "GlobalVariableName" "GlobalVariableType" "Value"

Optional properties to shape result

pageNumber
integer <int32>
pageSize
integer <int32>

Responses

Response Schema: application/json
pageNumber
integer <int32>
pageSize
integer <int32>
totalPages
integer <int32>
totalCount
integer <int32>
Array of objects or null (HttpLink)
Array
rel
string (HttpRel)
Enum: "Next" "Prev"
href
string or null
Array of objects or null (ItemVariableRelationViewModel)
Array
globalVariableId
string <uuid>
value
string or null
state
string (ItemVariableRelationState)
Enum: "Attached" "Detached"
globalVariableName
string or null
globalVariableType
string (GlobalVariableType)
Enum: "String" "Integer" "Double"

Response samples

Content type
application/json
{
  • "totalCount": 2,
  • "pageNumber": 1,
  • "pageSize": 10,
  • "data": [
    • {
      },
    • {
      }
    ]
}

Puts global variables onto items

Associates global variables with items by providing item IDs and corresponding global variable data.

Authorizations:
bearerPatAuth
Request Body schema:

Global variables for items

Array
itemId
string or null
Array of objects or null (ItemVariableRelationBaseViewModel)
Array
globalVariableId
string <uuid>
value
string or null
state
string (ItemVariableRelationState)
Enum: "Attached" "Detached"

Responses

Response Schema: application/json
pageNumber
integer <int32>
pageSize
integer <int32>
totalPages
integer <int32>
totalCount
integer <int32>
Array of objects or null (HttpLink)
Array
rel
string (HttpRel)
Enum: "Next" "Prev"
href
string or null
Array of objects or null (ItemVariableRelationViewModel)
Array
globalVariableId
string <uuid>
value
string or null
state
string (ItemVariableRelationState)
Enum: "Attached" "Detached"
globalVariableName
string or null
globalVariableType
string (GlobalVariableType)
Enum: "String" "Integer" "Double"

Request samples

Content type
[
  • {
    • "itemId": "string",
    • "globalVariables": [
      ]
    }
]

Response samples

Content type
application/json
{
  • "totalCount": 2,
  • "pageNumber": 1,
  • "pageSize": 10,
  • "data": [
    • {
      },
    • {
      }
    ]
}

Gets a list of items fitting the given query

Gets a list of items fitting the given query with filtering and pagination options.

Authorizations:
bearerPatAuth
query Parameters
pageNumber
integer <int32>
pageSize
integer <int32>
Request Body schema:

Filter

object (ItemFindGlobalVariableFilter)
globalVariableId
string <uuid>
globalVariableValue
string or null
identStationIds
Array of strings or null <uuid> [ items <uuid > ]
itemInGivenIdentStations
boolean
startTimestamp
integer or null <int64>
endTimestamp
integer or null <int64>

Responses

Response Schema: application/json
pageNumber
integer <int32>
pageSize
integer <int32>
totalPages
integer <int32>
totalCount
integer <int32>
Array of objects or null (HttpLink)
Array
rel
string (HttpRel)
Enum: "Next" "Prev"
href
string or null
Array of objects or null (ItemViewModel)
Array
id
integer <int64>
object (UniqueIdentifier)
value
string <uuid>
itemId
string or null
object (ItemTypeViewModel)
itemTypeId
integer <int32>
object (ItemSequenceViewModel)
itemSequenceId
integer <int64>
identStationId
string <uuid>
identStationName
string or null
entryTime
string <date-time>
exitTime
string or null <date-time>
durationInSeconds
integer or null <int32>
manuallyTriggeredEntryByUserId
string or null <uuid>
object (MoneoUserViewModel)
manuallyTriggeredExitByUserId
string or null <uuid>
object (MoneoUserViewModel)
Array of objects or null (ItemSequenceDataViewModel)
object (ItemSequenceQualityDataViewModel)
object (ItemSequenceViewModel)
itemSequenceId
integer <int64>
identStationId
string <uuid>
identStationName
string or null
entryTime
string <date-time>
exitTime
string or null <date-time>
durationInSeconds
integer or null <int32>
manuallyTriggeredEntryByUserId
string or null <uuid>
object (MoneoUserViewModel)
manuallyTriggeredExitByUserId
string or null <uuid>
object (MoneoUserViewModel)
Array of objects or null (ItemSequenceDataViewModel)
object (ItemSequenceQualityDataViewModel)
Array of objects or null (ItemVariableRelationViewModel)
Array
globalVariableId
string <uuid>
value
string or null
state
string (ItemVariableRelationState)
Enum: "Attached" "Detached"
globalVariableName
string or null
globalVariableType
string (GlobalVariableType)
Enum: "String" "Integer" "Double"

Request samples

Content type
{
  • "globalVariableFilter": {
    • "globalVariableId": "123e4567-e89b-12d3-a456-426614174000",
    • "globalVariableValue": "SomeValue"
    },
  • "identStationIds": [
    • "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
  • "itemInGivenIdentStations": true,
  • "startTimestamp": 0,
  • "endTimestamp": 0
}

Response samples

Content type
application/json
{
  • "totalCount": 2,
  • "pageNumber": 1,
  • "pageSize": 10,
  • "data": [
    • {
      },
    • {
      }
    ]
}

Gets an Item

Gets the item for the given itemId.

Authorizations:
bearerPatAuth
path Parameters
itemId
required
string

Responses

Response Schema: application/json
id
integer <int64>
object (UniqueIdentifier)
value
string <uuid>
itemId
string or null
object (ItemTypeViewModel)
itemTypeId
integer <int32>
object (ItemSequenceViewModel)
itemSequenceId
integer <int64>
identStationId
string <uuid>
identStationName
string or null
entryTime
string <date-time>
exitTime
string or null <date-time>
durationInSeconds
integer or null <int32>
manuallyTriggeredEntryByUserId
string or null <uuid>
object (MoneoUserViewModel)
moneoUserId
string <uuid>
firstName
string or null
lastName
string or null
manuallyTriggeredExitByUserId
string or null <uuid>
object (MoneoUserViewModel)
moneoUserId
string <uuid>
firstName
string or null
lastName
string or null
Array of objects or null (ItemSequenceDataViewModel)
Array
itemSequenceDataId
integer <int64>
itemSequenceId
integer <int64>
moneoThingWithPropertyId
string <uuid>
moneoThingWithPropertyUniqueIdentifier
string or null
moneoThingWithPropertyTopologyNodeId
string <uuid>
entryValue
string or null
entryTimestamp
string <date-time>
exitValue
string or null
exitTimestamp
string <date-time>
durationMinValue
number or null <double>
durationMinValueTimestamp
string <date-time>
durationMaxValue
number or null <double>
durationMaxValueTimestamp
string <date-time>
durationAverageValue
number or null <double>
state
string (ItemSequenceDataState)
Enum: "Pending" "Done" "Aborted"
customName
string or null
recordingType
integer <int32>
object (ItemSequenceQualityDataViewModel)
itemSequenceQualityDataId
integer <int64>
itemSequenceId
integer <int64>
moneoThingWithPropertyId
string <uuid>
moneoThingWithPropertyUniqueIdentifier
string or null
value
number or null <double>
timeStamp
string <date-time>
object (ItemSequenceQualityDataSettingsViewModel)
itemSequenceQualityDataSettingsId
integer <int64>
object (QualitySetting)
qualityResult
string (Quality)
Enum: "Invalid" "Pass" "Fail" "Scrap" "NotAvailable"
state
string (ItemSequenceDataState)
Enum: "Pending" "Done" "Aborted"
object (ItemSequenceViewModel)
itemSequenceId
integer <int64>
identStationId
string <uuid>
identStationName
string or null
entryTime
string <date-time>
exitTime
string or null <date-time>
durationInSeconds
integer or null <int32>
manuallyTriggeredEntryByUserId
string or null <uuid>
object (MoneoUserViewModel)
moneoUserId
string <uuid>
firstName
string or null
lastName
string or null
manuallyTriggeredExitByUserId
string or null <uuid>
object (MoneoUserViewModel)
moneoUserId
string <uuid>
firstName
string or null
lastName
string or null
Array of objects or null (ItemSequenceDataViewModel)
Array
itemSequenceDataId
integer <int64>
itemSequenceId
integer <int64>
moneoThingWithPropertyId
string <uuid>
moneoThingWithPropertyUniqueIdentifier
string or null
moneoThingWithPropertyTopologyNodeId
string <uuid>
entryValue
string or null
entryTimestamp
string <date-time>
exitValue
string or null
exitTimestamp
string <date-time>
durationMinValue
number or null <double>
durationMinValueTimestamp
string <date-time>
durationMaxValue
number or null <double>
durationMaxValueTimestamp
string <date-time>
durationAverageValue
number or null <double>
state
string (ItemSequenceDataState)
Enum: "Pending" "Done" "Aborted"
customName
string or null
recordingType
integer <int32>
object (ItemSequenceQualityDataViewModel)
itemSequenceQualityDataId
integer <int64>
itemSequenceId
integer <int64>
moneoThingWithPropertyId
string <uuid>
moneoThingWithPropertyUniqueIdentifier
string or null
value
number or null <double>
timeStamp
string <date-time>
object (ItemSequenceQualityDataSettingsViewModel)
itemSequenceQualityDataSettingsId
integer <int64>
object (QualitySetting)
qualityResult
string (Quality)
Enum: "Invalid" "Pass" "Fail" "Scrap" "NotAvailable"
state
string (ItemSequenceDataState)
Enum: "Pending" "Done" "Aborted"
Array of objects or null (ItemVariableRelationViewModel)
Array
globalVariableId
string <uuid>
value
string or null
state
string (ItemVariableRelationState)
Enum: "Attached" "Detached"
globalVariableName
string or null
globalVariableType
string (GlobalVariableType)
Enum: "String" "Integer" "Double"

Response samples

Content type
application/json
{
  • "id": 12345,
  • "uniqueIdentifier": {
    • "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    },
  • "itemId": "ITEM-123",
  • "itemType": {
    • "itemTypeId": 5
    },
  • "firstSequence": {
    • "itemSequenceId": 1,
    • "identStationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    • "identStationName": "Station A",
    • "entryTime": "2024-06-13T10:00:00Z",
    • "exitTime": "2024-06-13T11:00:00Z",
    • "durationInSeconds": 3600,
    • "manuallyTriggeredEntryByUserId": null,
    • "manuallyTriggeredEntryByUser": {
      },
    • "manuallyTriggeredExitByUserId": null,
    • "manuallyTriggeredExitByUser": {
      },
    • "itemSequenceDatas": [ ],
    • "itemSequenceQualityData": { }
    },
  • "latestSequence": { },
  • "itemVariables": [ ]
}