Resources and roles
Master Data Management creates the following roles:
Domain |
Role |
Permissions |
Equipment, Process |
Admin |
Read, Write and Delete for API actions |
Expert |
Read and Write for API actions |
|
User |
Read |
|
Material |
Material Manager |
Read, Write for Material API |
Material Reader |
Read for Material and Material Type API actions |
|
Material Cleaner |
Delete for Material API |
Here is the detailed permission matrix for the roles and resources:
| Method | API url | Description | Resource ID | Admin | Expert | User |
|---|---|---|---|---|---|---|
DeviceTypes |
||||||
GET |
/api/v1/{tenantId}/devicetypes/{id} |
Gets the specified device type |
urn.com.bosch.nexeed.entitytype.devicetype |
Yes |
Yes |
Yes |
PATCH |
/api/v1/{tenantId}/devicetypes/{id} |
Patches the specified device type |
Yes |
Yes |
No |
|
PUT |
/api/v1/{tenantId}/devicetypes/{id} |
Updates or creates the specified device type (deprecated) |
Yes |
Yes |
No |
|
PUT |
/api/v2/{tenantId}/devicetypes/{id} |
Updates the specified device type |
Yes |
Yes |
No |
|
DELETE |
/api/v1/{tenantId}/devicetypes/{id} |
Deletes the specified device type |
Yes |
No |
No |
|
GET |
/api/v1/{tenantId}/devicetypes |
Gets the device types with filter |
Yes |
Yes |
Yes |
|
POST |
/api/v1/{tenantId}/devicetypes |
Creates the device type |
Yes |
Yes |
No |
|
POST |
/query-api/v1/{tenantId}/devicetypes |
Gets the device types by RQL filter |
Yes |
Yes |
Yes |
|
POST |
/api/v1/{tenantId}/devicetypes/{id}/actions/copy |
Copies an existing device type |
Yes |
Yes |
No |
|
POST |
/api/v1/{tenantId}/devicetypes/{id}/actions/retire |
Sets the IsRetired field of the device type to TRUE |
urn.com.bosch.nexeed.entitytype.devicetype.action.retire |
Yes |
Yes |
No |
POST |
/api/v1/{tenantId}/devicetypes/{id}/actions/reactivate |
Sets the IsRetired field of the device type to FALSE |
Yes |
Yes |
No |
|
DeviceTypesRelations |
||||||
POST |
/api/v1/{tenantId}/devicetypes/{id}/relations/{predicate} |
Creates the relations |
Yes |
Yes |
Yes |
|
DELETE |
/api/v1/{tenantId}/devicetypes/{id}/relations/{predicate} |
Deletes the specified relations |
Yes |
Yes |
Yes |
|
GET |
/api/v1/{tenantId}/devicetypes/{id}/relations/{predicate} |
Gets the relations |
Yes |
Yes |
Yes |
|
Devices |
||||||
GET |
/api/v1/{tenantId}/devices/{id} |
Gets the specified device |
urn.com.bosch.nexeed.entitytype.device |
Yes |
Yes |
Yes |
PUT |
/api/v1/{tenantId}/devices/{id} |
Updates or creates the specified device (deprecated) |
Yes |
Yes |
No |
|
PUT |
/api/v2/{tenantId}/devices/{id} |
Updates the specified device |
Yes |
Yes |
No |
|
PATCH |
/api/v1/{tenantId}/devices/{id} |
Patches the specified device |
Yes |
Yes |
No |
|
DELETE |
/api/v1/{tenantId}/devices/{id} |
Deletes the specified device |
Yes |
No |
No |
|
GET |
/api/v1/{tenantId}/devices |
Gets the devices with filter |
Yes |
Yes |
Yes |
|
POST |
/api/v1/{tenantId}/devices |
Creates the device |
Yes |
Yes |
No |
|
POST |
/bulk-api/v1/{tenantId}/devices |
Creates the devices and the facilities relations |
Yes |
Yes |
No |
|
POST |
/query-api/v1/{tenantId}/devices |
Gets the devices by RQL filter |
Yes |
Yes |
Yes |
|
POST |
/api/v1/{tenantId}/devices/{id}/actions/retire |
Sets the isRetired field of the device to TRUE |
urn.com.bosch.nexeed.entitytype.device.action.retire |
Yes |
Yes |
No |
POST |
/api/v1/{tenantId}/devices/{id}/actions/reactivate |
Sets the isRetired field of the device to FALSE |
Yes |
Yes |
No |
|
DevicesRelations |
||||||
GET |
/api/v1/{tenantId}/devices/{id}/relations/{predicate} |
urn.com.bosch.nexeed.entitytype.device.relation |
Yes |
Yes |
Yes |
|
POST |
/api/v1/{tenantId}/devices/{id}/relations/{predicate} |
Yes |
Yes |
No |
||
DELETE |
/api/v1/{tenantId}/devices/{id}/relations/{predicate} |
Yes |
No |
No |
||
DevicesTags |
||||||
GET |
/api/v1/{tenantId}/devices/tags/{id} |
Gets the specified tag |
urn.com.bosch.nexeed.entitytype.device |
Yes |
Yes |
Yes |
PUT |
/api/v1/{tenantId}/devices/tags/{id} |
Updates or creates the specified tag |
Yes |
Yes |
No |
|
PATCH |
/api/v1/{tenantId}/devices/tags/{id} |
Patches the specified tag |
Yes |
Yes |
No |
|
DELETE |
/api/v1/{tenantId}/devices/tags/{id} |
Deletes the specified tag |
Yes |
No |
No |
|
GET |
/api/v1/{tenantId}/devices/tags |
Gets all tags with filter |
Yes |
Yes |
Yes |
|
POST |
/api/v1/{tenantId}/devices/tags |
Creates the tag |
Yes |
Yes |
No |
|
POST |
/query-api/v1/{tenantId}/devices/tags |
Gets the tags by RQL filter |
Yes |
Yes |
Yes |
|
CustomProperties for DeviceType |
||||||
POST |
/api/v1/{tenantId}/devicetypes/{id}/customproperties |
urn.com.bosch.nexeed.entitytype.devicetype.customproperty |
Yes |
Yes |
No |
|
PUT |
/api/v1/{tenantId}/devicetypes/{id}/customproperties/{propertyName} |
Yes |
Yes |
No |
||
PATCH |
/api/v1/{tenantId}/devicetypes/{id}/customproperties/{propertyName} |
Yes |
Yes |
No |
||
DELETE |
/api/v1/{tenantId}/devicetypes/{id}/customproperties/{propertyName} |
Yes |
No |
No |
||
CustomPropertyValues for Device |
||||||
POST |
/api/v1/{tenantId}/devices/{id}/custompropertyvalues |
urn.com.bosch.nexeed.entitytype.device.customproperty |
Yes |
Yes |
No |
|
PUT |
/api/v1/{tenantId}/devices/{id}/custompropertyvalues/{propertyName} |
Yes |
Yes |
No |
||
PATCH |
/api/v1/{tenantId}/devices/{id}/custompropertyvalues/{propertyName} |
Yes |
Yes |
No |
||
DELETE |
/api/v1/{tenantId}/devices/{id}/custompropertyvalues/{propertyName} |
Yes |
No |
No |
||
FacilityTypes |
||||||
GET |
/api/v2/{tenantId}/facilitytypes/{id} |
Gets the specified facility type |
urn.com.bosch.nexeed.entitytype.facilitytype |
Yes |
Yes |
Yes |
PATCH |
/api/v2/{tenantId}/facilitytypes/{id} |
Patches the specified facility type |
Yes |
Yes |
No |
|
PUT |
/api/v2/{tenantId}/facilitytypes/{id} |
Updates or creates the specified facility type (deprecated) |
Yes |
Yes |
No |
|
PUT |
/api/v3/{tenantId}/facilitytypes/{id} |
Updates the specified facility type |
Yes |
Yes |
No |
|
DELETE |
/api/v2/{tenantId}/facilitytypes/{id} |
Deletes the specified facility type |
Yes |
No |
No |
|
GET |
/api/v2/{tenantId}/facilitytypes |
Gets the facility types with filter |
Yes |
Yes |
Yes |
|
POST |
/api/v2/{tenantId}/facilitytypes |
Creates the facility type |
Yes |
Yes |
No |
|
POST |
/query-api/v2/{tenantId}/facilitytypes |
Gets the facility types by RQL filter |
Yes |
Yes |
Yes |
|
POST |
/api/v2/{tenantId}/facilitytypes/{id}/actions/retire |
Sets the IsRetired field of the facility type to TRUE |
urn.com.bosch.nexeed.entitytype.facilitytype.action.retire |
Yes |
Yes |
No |
POST |
/api/v2/{tenantId}/facilitytypes/{id}/actions/reactivate |
Sets the IsRetired field of the faclity type to FALSE |
Yes |
Yes |
No |
|
POST |
/api/v2/{tenantId}/facilitytypes/{id}/actions/setbuiltin |
Sets the IsBuiltIn field of the facility type to TRUE |
urn.com.bosch.nexeed.entitytype.facilitytype.action.builtin |
Yes |
Yes |
No |
POST |
/api/v2/{tenantId}/facilitytypes/{id}/actions/resetbuiltin |
Sets the IsBuiltIn field of the facility type to FALSE |
Yes |
Yes |
No |
|
FacilityTypeTranslations |
||||||
GET |
/api/v2/{tenantId}/facilitytypes/{id}/translations/{culture} |
urn.com.bosch.nexeed.entitytype.facilitytype.translation |
Yes |
Yes |
Yes |
|
PUT |
/api/v2/{tenantId}/facilitytypes/{id}/translations/{culture} |
Yes |
Yes |
No |
||
PATCH |
/api/v2/{tenantId}/facilitytypes/{id}/translations/{culture} |
Yes |
Yes |
No |
||
DELETE |
/api/v2/{tenantId}/facilitytypes/{id}/translations/{culture} |
Yes |
No |
No |
||
GET |
/api/v2/{tenantId}/facilitytypes/{id}/translations |
Yes |
Yes |
Yes |
||
POST |
/bulk-api/v2/{tenantId}/facilitytypes/translations |
Yes |
Yes |
No |
||
Facilities |
||||||
GET |
/api/v2/{tenantId}/facilities/{id} |
Gets the specified facility |
urn.com.bosch.nexeed.entitytype.facility |
Yes |
Yes |
Yes |
PATCH |
/api/v2/{tenantId}/facilities/{id} |
Patches the specified facility |
Yes |
Yes |
No |
|
PUT |
/api/v2/{tenantId}/facilities/{id} |
Updates or creates the specified facility (deprecated) |
Yes |
Yes |
No |
|
PUT |
/api/v3/{tenantId}/facilities/{id} |
Updates the specified facility |
Yes |
Yes |
No |
|
DELETE |
/api/v2/{tenantId}/facilities/{id} |
Deletes the specified facility |
Yes |
No |
No |
|
GET |
/api/v2/{tenantId}/facilities |
Gets the facilities with filter |
Yes |
Yes |
Yes |
|
POST |
/api/v2/{tenantId}/facilities |
Creates the facility |
Yes |
Yes |
No |
|
POST |
/query-api/v2/{tenantId}/facilities |
Gets the facilities by RQL filter |
Yes |
Yes |
Yes |
|
GET |
/api/v2/{tenantId}/facilities/tree/{id} |
Gets the facility tree with filter |
Yes |
Yes |
Yes |
|
POST |
/query-api/v2/{tenantId}/facilities/tree/{id} |
Gets the facility tree by RQL filter |
Yes |
Yes |
Yes |
|
POST |
/bulk-api/v2/{tenantId}/facilities |
Creates the facilities |
Yes |
Yes |
No |
|
DELETE |
/bulk-api/v2/{tenantId}/facilities |
Deletes the specified facilities |
Yes |
No |
No |
|
POST |
/api/v2/{tenantId}/facilities/import |
Imports facilities |
Yes |
Yes |
No |
|
POST |
/api/v2/{tenantId}/facilities/{id}/actions/retire |
Sets the IsRetired field of the facility to TRUE |
urn.com.bosch.nexeed.entitytype.facility.action.retire |
Yes |
Yes |
No |
POST |
/api/v2/{tenantId}/facilities/{id}/actions/reactivate |
Sets the IsRetired field of the facility to FALSE |
Yes |
Yes |
No |
|
FacilitiesRelations |
||||||
GET |
/api/v2/{tenantId}/facilities/{id}/relations/{predicate} |
urn.com.bosch.nexeed.entitytype.facility.relation |
Yes |
Yes |
Yes |
|
POST |
/api/v2/{tenantId}/facilities/{id}/relations/{predicate} |
Yes |
Yes |
No |
||
DELETE |
/api/v2/{tenantId}/facilities/{id}/relations/{predicate} |
Yes |
No |
No |
||
FacilityTranslations |
||||||
GET |
/api/v2/{tenantId}/facilities/{id}/translations/{culture} |
urn.com.bosch.nexeed.entitytype.facility.translation |
Yes |
Yes |
Yes |
|
PUT |
/api/v2/{tenantId}/facilities/{id}/translations/{culture} |
Yes |
Yes |
No |
||
PATCH |
/api/v2/{tenantId}/facilities/{id}/translations/{culture} |
Yes |
Yes |
No |
||
DELETE |
/api/v2/{tenantId}/facilities/{id}/translations/{culture} |
Yes |
No |
No |
||
GET |
/api/v2/{tenantId}/facilities/{id}/translations |
Yes |
Yes |
Yes |
||
POST |
/bulk-api/v2/{tenantId}/facilities/translations |
Yes |
Yes |
No |
||
CustomProperties for FacilityType |
||||||
POST |
/api/v2/{tenantId}/facilitytypes/{id}/customproperties |
urn.com.bosch.nexeed.entitytype.facilitytype.customproperty |
Yes |
Yes |
Yes |
|
PUT |
/api/v2/{tenantId}/facilitytypes/{id}/customproperties/{propertyName} |
Yes |
Yes |
No |
||
PATCH |
/api/v2/{tenantId}/facilitytypes/{id}/customproperties/{propertyName} |
Yes |
Yes |
No |
||
DELETE |
/api/v2/{tenantId}/facilitytypes/{id}/customproperties/{propertyName} |
Yes |
No |
No |
||
CustomPropertyValues for Facility |
||||||
POST |
/api/v2/{tenantId}/facilities/{id}/custompropertyvalues |
urn.com.bosch.nexeed.entitytype.facility.customproperty |
Yes |
Yes |
Yes |
|
PUT |
/api/v2/{tenantId}/facilities/{id}/custompropertyvalues/{propertyName} |
Yes |
Yes |
No |
||
PATCH |
/api/v2/{tenantId}/facilities/{id}/custompropertyvalues/{propertyName} |
Yes |
Yes |
No |
||
DELETE |
/api/v2/{tenantId}/facilities/{id}/custompropertyvalues/{propertyName} |
Yes |
No |
No |
||
Errors |
||||||
GET |
/api/v1/{tenantId}/errors/{id} |
Gets the specified error |
urn.com.bosch.nexeed.entitytype.error |
Yes |
Yes |
Yes |
PATCH |
/api/v1/{tenantId}/errors/{id} |
Patches the specified error |
Yes |
Yes |
No |
|
PUT |
/api/v1/{tenantId}/errors/{id} |
Updates or creates the specified error (deprecated) |
Yes |
No |
No |
|
PUT |
/api/v2/{tenantId}/errors/{id} |
Updates the specified error |
Yes |
No |
No |
|
DELETE |
/api/v1/{tenantId}/errors/{id} |
Deletes the specified error |
Yes |
No |
No |
|
GET |
/api/v1/{tenantId}/errors |
Gets the errors with filter |
Yes |
Yes |
Yes |
|
POST |
/api/v1/{tenantId}/errors |
Creates the error |
Yes |
Yes |
No |
|
POST |
/query-api/v1/{tenantId}/errors |
Gets the errors by RQL filter |
Yes |
Yes |
Yes |
|
POST |
/bulk-api/v1/{tenantId}/errors |
Creates the errors |
Yes |
Yes |
No |
|
ErrorsRelations |
||||||
DELETE |
/api/v1/{tenantId}/errors/{id}/relations/{predicate} |
Deletes the specified relations |
urn.com.bosch.nexeed.entitytype.error.relation |
Yes |
No |
No |
POST |
/api/v1/{tenantId}/errors/{id}/relations/{predicate} |
Creates the relations |
Yes |
Yes |
No |
|
GET |
/api/v1/{tenantId}/errors/{id}/relations/{predicate} |
Gets the relations |
Yes |
Yes |
Yes |
|
ErrorTranslations |
||||||
POST |
/bulk-api/v1/{tenantId}/errors/translations |
urn.com.bosch.nexeed.entitytype.error.translation |
Yes |
Yes |
No |
|
GET |
/api/v1/{tenantId}/errors/{id}/translations/{culture} |
Yes |
Yes |
Yes |
||
PUT |
/api/v1/{tenantId}/errors/{id}/translations/{culture} |
Yes |
Yes |
No |
||
PATCH |
/api/v1/{tenantId}/errors/{id}/translations/{culture} |
Yes |
Yes |
No |
||
DELETE |
/api/v1/{tenantId}/errors/{id}/translations/{culture} |
Yes |
No |
No |
||
GET |
/api/v1/{tenantId}/errors/{id}/translations |
Yes |
Yes |
Yes |
||
MeasuringPoints |
||||||
GET |
/api/v1/{tenantId}/measuringpoints/{id} |
Gets the specified measuring point |
urn.com.bosch.nexeed.entitytype.measuringpoint |
Yes |
Yes |
Yes |
PATCH |
/api/v1/{tenantId}/measuringpoints/{id} |
Patches the specified measuring point |
Yes |
Yes |
No |
|
PUT |
/api/v1/{tenantId}/measuringpoints/{id} |
Updates or creates the specified measuring point (deprecated) |
Yes |
Yes |
No |
|
PUT |
/api/v2/{tenantId}/measuringpoints/{id} |
Updates the specified measuring point |
Yes |
Yes |
No |
|
DELETE |
/api/v1/{tenantId}/measuringpoints/{id} |
Deletes the specified measuring point |
Yes |
No |
No |
|
GET |
/api/v1/{tenantId}/measuringpoints |
Gets the measuring points with filter |
Yes |
Yes |
Yes |
|
POST |
/api/v1/{tenantId}/measuringpoints |
Creates the measuring point |
Yes |
Yes |
No |
|
POST |
/query-api/v1/{tenantId}/measuringpoints |
Gets the measuring points by RQL filter |
Yes |
Yes |
Yes |
|
POST |
/bulk-api/v1/{tenantId}/measuringpoints |
Creates the measuring points |
Yes |
Yes |
No |
|
MeasuringPointsRelations |
||||||
DELETE |
/api/v1/{tenantId}/measuringpoints/{id}/relations/{predicate} |
Deletes the specified relations |
urn.com.bosch.nexeed.entitytype.measuringpoint.relation |
Yes |
No |
No |
POST |
/api/v1/{tenantId}/measuringpoints/{id}/relations/{predicate} |
Creates the relations |
Yes |
Yes |
No |
|
GET |
/api/v1/{tenantId}/measuringpoints/{id}/relations/{predicate} |
Yes |
Yes |
Yes |
||
MeasuringPointTranslations |
||||||
POST |
/bulk-api/v1/{tenantId}/measuringpoints/translations |
urn.com.bosch.nexeed.entitytype.measuringpoint.translation |
Yes |
Yes |
No |
|
GET |
/api/v1/{tenantId}/measuringpoints/{id}/translations/{culture} |
Yes |
Yes |
Yes |
||
PUT |
/api/v1/{tenantId}/measuringpoints/{id}/translations/{culture} |
Yes |
Yes |
No |
||
PATCH |
/api/v1/{tenantId}/measuringpoints/{id}/translations/{culture} |
Yes |
Yes |
No |
||
DELETE |
/api/v1/{tenantId}/measuringpoints/{id}/translations/{culture} |
Yes |
No |
No |
||
GET |
/api/v1/{tenantId}/measuringpoints/{id}/translations |
Yes |
Yes |
Yes |
||
Tags |
||||||
GET |
/api/v1/{tenantId}/tags/{id} |
urn.com.bosch.nexeed.entitytype.facility |
Yes |
Yes |
Yes |
|
PUT |
/api/v1/{tenantId}/tags/{id} |
Yes |
Yes |
No |
||
PATCH |
/api/v1/{tenantId}/tags/{id} |
Yes |
Yes |
No |
||
DELETE |
/api/v1/{tenantId}/tags/{id} |
Yes |
No |
No |
||
GET |
/api/v1/{tenantId}/tags |
Yes |
Yes |
Yes |
||
POST |
/api/v1/{tenantId}/tags |
Yes |
Yes |
No |
||
POST |
/query-api/v1/{tenantId}/tags |
Yes |
Yes |
Yes |
||
Integration |
||||||
GET |
/integration/v1/entitytypes/{entityType}/{ownerId}/entities/{id} |
Gets entity information corresponding to event |
Yes |
Yes |
Yes |
|
Materials |
||||||
POST |
/api/v1/{tenantId}/materials |
Creates a material |
urn.com.bosch.nexeed.entitytype.material |
Yes |
Yes |
Yes |
DELETE |
/api/v1/{tenantId}/materials/{id} |
Deletes the specified material |
Yes |
Yes |
No |
|
PUT |
/api/v1/{tenantId}/materials/{id} |
Updates the specified material |
Yes |
Yes |
No |
|
PATCH |
/api/v1/{tenantId}/materials/{id} |
Patches the specified material |
Yes |
Yes |
No |
|
| Method | API url | Description | Resource ID | Material Manager | Material Reader | Material Cleaner |
|---|---|---|---|---|---|---|
Materials |
||||||
GET |
/api/v1/{tenantId}/materials |
Gets all the materials |
urn.com.bosch.nexeed.entitytype.material |
Yes |
Yes |
No |
GET |
/api/v1/{tenantId}/materials/{id} |
Gets a material by id |
Yes |
Yes |
No |
|
POST |
/api/v1/{tenantId}/materials |
Creates a material |
Yes |
No |
No |
|
PUT |
/api/v1/{tenantId}/materials/{id} |
Updates the specified material |
Yes |
No |
No |
|
PATCH |
/api/v1/{tenantId}/materials/{id} |
Patches the specified material |
Yes |
No |
No |
|
DELETE |
/api/v1/{tenantId}/materials/{id} |
Deletes the specified material |
No |
No |
Yes |
|
Material Types |
||||||
GET |
/api/v1/{tenantId}/materialtypes |
Gets all the material types |
urn.com.bosch.nexeed.entitytype.materialtype |
Yes |
Yes |
No |
GET |
/api/v1/{tenantId}/materialtypes/{id} |
Gets a material type by id |
Yes |
Yes |
No |
|
POST |
/api/v1/{tenantId}/materialtypes |
Creates a material type |
Yes |
No |
No |
|
PUT |
/api/v1/{tenantId}/materialtypes/{id} |
Updates the specified material type |
Yes |
No |
No |
|
PATCH |
/api/v1/{tenantId}/materialtypes/{id} |
Patches the specified material type |
Yes |
No |
No |
|
DELETE |
/api/v1/{tenantId}/materialtypes/{id} |
Deletes the specified material type |
Yes |
No |
Yes |
|