Entities & fields
Device Type
| Field | Required | Type | Restrictions | Description |
|---|---|---|---|---|
Metadata/ModelId |
X |
string |
The unique document type that corresponds to the provided content, e.g. urn:industry:bosch:entitytype:devicetype:api:equipment:v1 |
|
Base Category |
X |
enum |
Machine |
When specifying a device type you have to specify to which category this belongs |
Id |
X |
string |
max length 256 |
The unique identifier of the device type master data (only for GET) |
Name |
X |
string |
max length 1024 |
The (display) name of this device type |
Manufacturer |
X |
string |
max length 256 |
The manufacturer of this device type |
Version |
X |
string |
max length 20 |
The device type version |
CustomProperties |
CustomProperty[] |
List of custom property instances |
||
IsRetired |
bool |
Only for get: indicates that this device type has been retired. This field an only be manipulated by using corresponding Actions that are available on this Api. Default: false. If this field is included in the PAYLOAD (POST/PUT/PATCH) it will be ignored. |
Device
| Field | Required | Type | Restrictions | Description |
|---|---|---|---|---|
Metadata/ModelId |
X |
string |
The unique document type that corresponds to the provided content, e.g. urn:industry:bosch:entitytype:device:api:equipment:v1 |
|
Base Category |
X |
enum |
Machine |
When specifying a device you have to specify to which category this belongs. This correlates with the Base Category of the referenced Device Type and must be set by the service implicitly and though is only relevant for GET |
DeviceTypeId |
X |
string |
max length 256 |
The unique identifier of the referenced Device Type |
Id |
X |
string |
max length 256 |
The unique identifier of the device master data (only for GET) |
Name |
X |
string |
max length 1024 |
The (display) name of this device instance |
Description |
string |
max length 256 |
The description of this device instance |
|
CustomPropertyValues |
CustomPropertyValue[] |
List of custom property value instances |
||
RecordState |
Default: Approved |
enum |
Approved, Unapproved, Retired |
Indicates the state of a data record. If a record is set to not in state 'Approved', the record will not be returned by GET operations, besides of GET by ID |
IsRetired |
bool |
Only for get: indicates that this device has been retired. This field can only be manipulated by using corresponding Actions that are available on this API. Default: false. If this field is inlcluded in the PAYLOAD (POST/PUT/PATCH) it will be ignored. |
||
TechnicalId |
string |
max length 256 |
Technical Id of device given to the Id and hard-wired with the physical device, often used for communication to device |
|
Relations |
Dictionary |
Only for GET: returns all kind of relations for the corresponding measuring point if the query string parameter "relations" is set to TRUE (default: false) |
Facility Type
| Field | Required | Type | Restrictions | Description |
|---|---|---|---|---|
Metadata/ModelId |
X |
string |
The unique document type that corresponds to the provided content, e.g. urn:industry:bosch:entitytype:facilitytype:api:equipment:v2 |
|
Id |
X |
string |
max length 256 |
The unique identifier of the facility type master data (only for GET) |
BaseClass |
X |
enum |
Enterprise, Site, Area, Work Center, Work Unit |
Base Class of of this facility type |
RawName |
X |
string |
max length 1024 |
The (neutral untranslated) name of this facility type |
Version |
X |
string |
max length 20 |
The facility type version |
Name |
CultureSpecificTranslation |
max text length 256, max culture code length 5 |
Only for GET: Text and Culture of translated text. IN case of a fallback scenario it may be that a caller requests "de-AT" but there is only a fallback value "de-DE" or even no translation available. Then the "en-EN" translation will be returned. This element is only returned if the query string parameter "Culture" has been specified by the caller. |
|
CustomProperties |
CustomProperty[] |
List of custom property instances |
||
CustomPropertyManipulation |
enum |
None, Modify, Add, All |
Indicates if the custom properties may be edited and in which degree. None: No changes allowed. Modify: Existing custom attributes can be edited but no new ones can be added nor deleted. Add: New Custom Attributes can be added and existing may be deleted. All (DEFAULT): Allow all changes |
|
IsRetired |
bool |
Only for get: indicates that this facility type has been retired. This field can only be manipulated by using corresponding Actions that are available on this Api. Default: false. If this field is included in the PAYLOAD (POST/PUT/PATCH) it will be ignored. |
||
IsBuiltIn |
bool |
Indicates that this facility type is one of the default types that are delivered with the solution as a basic set of facility types. These cannot be manipulated or deleted by the customer. This field cannot be set directly when creating or updating the record but can only be manipulated by the corresponding ACTION methods in this API. On Creation this flag is set to FALSE (default). |
Facility
| Field | Required | Type | Restrictions | Description |
|---|---|---|---|---|
Metadata/ModelId |
X |
string |
The unique document type that corresponds to the provided content, e.g. urn:industry:bosch:entitytype:facility:api:equipment:v2 |
|
Id |
X |
string |
max length 256 |
The unique identifier of the facility master data (only for GET) |
ParentFacilityId |
string |
max length 256 |
Hierarchical PARENT facility of this facility (if-any). Caution: the specifiy facility (types) that can be set as parent are restricted by the InstanceBehavior.AllowedParentFacilityIds field. Example: Facility Type "Station" can only be linked to Facility Type "Line" |
|
FacilityTypeId |
X |
string |
max length 256 |
The unique identifier of the referenced Facility Type |
BaseClass |
enum |
Enterprise, Site, Area, Work Center, Work Unit |
The value is also correlated to the base class of the referenced facility type (id). Virtual: will be set implicitly through the derived data models. (ignored if part of the payload) |
|
RawName |
X |
string |
max length 1024 |
The (neutral untranslated) name of this facility |
Version |
X |
string |
max length 20 |
The facility version |
Name |
CultureSpecificTranslation |
max text length 256, max culture code length 5 |
Only for GET: Text and Culture of translated text. IN case of a fallback scenario it may be that a caller requests "de-AT" but there is only a fallback value "de-DE" or even no translation available. Then the "en-EN" translation will be returned. This element is only returned if the query string parameter "Culture" has been specified by the caller. |
|
IsRetired |
bool |
Only for get: indicates that this facility type has been retired. This field can only be manipulated by using corresponding Actions that are available on this Api. Default: false. If this field is included in the PAYLOAD (POST/PUT/PATCH) it will be ignored. |
||
CustomPropertyValues |
CustomPropertyValue[] |
List of custom property value instances |
||
Identifiers |
FacilityIdentifier[] |
A list with additional external identifiers of a facility (e.g. SystemId coming from MES) |
||
Relations |
Dictionary |
Only for GET: returns all kind of relations for the corresponding measuring point if the query string parameter "relations" is set to TRUE (default: false) |
Error
| Field | Required | Type | Restrictions | Description |
|---|---|---|---|---|
Metadata/ModelId |
X |
string |
The unique document type that corresponds to the provided content, e.g. urn:industry:bosch:entitytype:error:api:equipment:v1 |
|
Id |
X |
string |
max Length 256 |
The unique identifier of the error(only for GET) |
ErrorNo |
X |
uint |
The error number |
|
ErrorText |
string |
max length 300 |
The multilingual descriptive text of the error, translations provide alternatives according to culture-codes |
|
Severity |
int/enum |
1=error, 2=warning, 3=info |
The error severity |
|
Relations |
Dictionary |
Only for GET: returns all kind of relations for the corresponding measuring point if the query string parameter "relations" is set to TRUE (default: false) |
Measuring Point
| Field | Required | Type | Restrictions | Description |
|---|---|---|---|---|
Metadata/ModelId |
X |
string |
The unique document type that corresponds to the provided content, e.g. urn:industry:bosch:entitytype:measuringpoint:api:equipment:v1 |
|
Id |
X |
string |
max length 256 |
The unique identifier of the measuring point(only for GET) |
RawName |
X |
string |
max length 256 |
The (neutral untranslated) name of this measuring point |
Name |
CultureSpecificTranslation |
max length 256 |
Only for GET: Text and Culture of translated text. IN case of a fallback scenario it may be that a caller requests "de-AT" but there is only a fallback value "de-DE" or even no translation available. Then the "en-EN" translation will be returned. |
|
Unit |
string |
max length 16 |
Physical Unit of the measurement point (if available) |
|
DisplayOptions |
string |
max length 10 |
Options that should be used for the visual representation of the value of the measurement point |
|
DataType |
int |
Data type of the result value |
||
Category |
enum |
The category of the measuring point. The category is an enumeration containing the following values: Measurement, Process Value Stream, Process Curve. For Oracle on-premise compatibility the default value should be "Measurement" |
||
RecordState |
Default: Approved |
enum |
Approved, Unapproved |
Indicates the state of a data record. Default is 'Approved'. If a record is set to state 'Unapproved', the record will not be returned by GET operations, besides of GET by ID. Once a record is set to state Approved it cannot be set back to Unapproved. |
Relations |
Dictionary |
Only for GET: returns all kind of relations for the corresponding measuring point if the query string parameter "relations" is set to TRUE (default: false) |
Process
| Field | Type and Constrains | Description |
|---|---|---|
Id |
Guid |
Unique Id |
ProcessNumber |
Integer, max 40 digits |
Process number, used to to identify and sort processes from expression |
Name |
max 256 characters |
Language-depended name of process |
Description |
max 1024 characters |
Language-depended description of process |
Origin |
max 256 characters |
Source of data, or the source SystemId in case of transfer from MES via Sync Service |
Created |
DateTime ISO 8601 |
Date and time when data records has been created |
Changed |
DateTime ISO 8601 |
Date and time when data records has been modified |
ProcessGroup
| Id | Guid | Unique Id |
|---|---|---|
Name |
max 256 characters |
Language-depended name of process group |
Description |
max 1024 characters |
Language-depended description of process group |
Source |
max 256 characters |
Source of data, or the source SystemId in case of transfer from MES via Sync Service |
Created |
DateTime ISO 8601 |
Date and time when data records has been created |
Changed |
DateTime ISO 8601 |
Date and time when data records has been modified |
Processes |
Array of strings, max 40 |
List of processes belonging to this group |
Material
| Field | Required | Type | Restrictions | Description |
|---|---|---|---|---|
Id |
X |
Guid |
The unique identifier of the material |
|
TenantId |
X |
Guid |
The tenant identifier |
|
MaterialNo |
X |
string |
max 32 characters |
The material number that is unique |
Name |
X |
string |
max 256 characters |
The material name |
Description |
string |
max 1024 characters |
The material description |
|
MaterialType |
string |
max 32 characters |
The material description |
|
IsActive |
X |
bool |
The material description |
|
CreatedOn |
X |
DateTime ISO 8601 |
Date and time when data records has been created |
|
ModifiedOn |
X |
DateTime ISO 8601 |
Date and time when data records has been modified |
MaterialType
| Field | Required | Type | Restrictions | Description |
|---|---|---|---|---|
Id |
X |
Guid |
The unique identifier of the material type |
|
TenantId |
X |
Guid |
The tenant identifier |
|
Name |
X |
string |
max 256 characters |
The name of the material type |
Description |
string |
max 1024 characters |
The description of the material type |
|
IsDeleted |
X |
bool |
The state of the material type |
|
CreatedOn |
X |
DateTime ISO 8601 |
Date and time when data records has been created |
|
ModifiedOn |
X |
DateTime ISO 8601 |
Date and time when data records has been modified |