This document describes an abstract service, which, if implemented by an application system, can be used query to an Inventory system for Inventory data related to application systems.
This document describes an abstract Arrowhead Framework service meant to enable querying for Inventory data related to application systems.
This section lists the interfaces that must be exposed by Inventory systems in alphabetical order. In particular, each subsection names an abstract interface, an input type, an output type and a set of possible exceptions, in that order. The input type is named inside parentheses, while the output type is preceded by a colon. Input and output types are only denoted when accepted or returned, respectively, by the interface in question. All abstract data types named in this section are defined in the Information model section.
interface GetInventoryData(InventoryId): InventoryData
Called to acquire the application system's inventory data, identified by ÌnventoryId.
interface GetInventorySystems(): SystemList
Called to acquire for systems present in the Inventory system.
Here, all data objects that can be part of Inventory service calls are listed in alphabetic order. Note that each subsection, which describes one type of object, begins with the struct or union keywords. The former is used to denote a collection of named fields, each with its own data type, while the latter is used to express that a value is allowed to be any one out of a number of listed variant types. As a complement to the explicitly defined types in this section, there is also a list of implicit primitive types, which are used to represent things like hashes and identifiers.
| Field | Type | Description |
|---|---|---|
data |
Custom | System specific data - key-value pairs |
| Field | Type | Description | Mandatory |
|---|---|---|---|
inventoryId |
String | The system's Id in this Inventory system | true |
systemName |
String | Identity of the system | false |
metadata |
Custom | Metadata - key-value pairs | false |
| Field | Type | Description | Mandatory |
|---|---|---|---|
count |
Integer | Number of records found | true |
data |
Array<System> | Array of Systems that the Inventory contains | true |
Types and structures mentioned throughout this document that are assumed to be available to implementations of this service. The concrete interpretations of each of these types and structures must be provided by any IDD document claiming to implement this service.
| Type | Description |
|---|---|
| Array <A> | An ordered collection of elements, where each element conforms to type A. Empty arrays are omitted. |
| Custom | Any suitable type chosen by the implementor of the service. |
| String | An arbitrary UTF-8 string. |