Download OpenAPI specification:Download
Eclipse hawkBit™ is a domain-independent back-end framework for rolling out software updates to constrained edge devices as well as more powerful controllers and gateways connected to IP based networking infrastructure.
Handles the GET request of retrieving a single distribution set. Required permission: READ_REPOSITORY
distributionSetId required | integer <int64> |
{- "createdBy": "bumlux",
- "createdAt": 1682408574924,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408574925,
- "name": "DS",
- "description": "Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1",
- "version": "1.0",
- "modules": [
- {
- "createdBy": "bumlux",
- "createdAt": 1682408574921,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408574926,
- "name": "Firmware",
- "description": "Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1",
- "version": "1.0.42",
- "type": "os",
- "typeName": "OS",
- "vendor": "vendor Limited Inc, California",
- "locked": true,
- "deleted": false,
- "encrypted": false,
- "id": 18
}, - {
- "createdBy": "bumlux",
- "createdAt": 1682408574920,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408574925,
- "name": "app runtime",
- "description": "Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1",
- "version": "1.0.25",
- "type": "runtime",
- "typeName": "runtime",
- "vendor": "vendor GmbH, Stuttgart, Germany",
- "locked": true,
- "deleted": false,
- "encrypted": false,
- "id": 17
}, - {
- "createdBy": "bumlux",
- "createdAt": 1682408574919,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408574926,
- "name": "application",
- "description": "Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1",
- "version": "1.0.67",
- "type": "application",
- "typeName": "Application",
- "vendor": "vendor Limited, California",
- "locked": true,
- "deleted": false,
- "encrypted": false,
- "id": 16
}
], - "requiredMigrationStep": false,
- "type": "test_default_ds_type",
- "typeName": "OS (FW) mandatory, runtime (FW) and app (SW) optional",
- "complete": true,
- "deleted": false,
- "valid": true,
- "_links": {
- "modules": {
}, - "metadata": {
}
}, - "id": 6
}
Handles the UPDATE request for a single Distribution Set. Required permission: UPDATE_REPOSITORY
distributionSetId required | integer <int64> |
name | string The name of the entity |
description | string The description of the entity |
version | string Package version |
locked | boolean Should be set only if change of locked state is requested. If put, the distribution set locked flag will be set to the requested. Note: unlock (i.e. set this property to false) with extreme care! In general once distribution set is locked it shall not be unlocked. Note that it could have been assigned / deployed to targets. |
requiredMigrationStep | boolean True if DS is a required migration step for another DS. As a result the DS’s assignment will not be cancelled when another DS is assigned (note: updatable only if DS is not yet assigned to a target) |
{- "name": "dsOne",
- "description": "Description of the distribution set.",
- "version": "1.0.0",
- "locked": true,
- "requiredMigrationStep": false
}
{- "createdBy": "bumlux",
- "createdAt": 1682408574924,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408574925,
- "name": "DS",
- "description": "Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1",
- "version": "1.0",
- "modules": [
- {
- "createdBy": "bumlux",
- "createdAt": 1682408574921,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408574926,
- "name": "Firmware",
- "description": "Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1",
- "version": "1.0.42",
- "type": "os",
- "typeName": "OS",
- "vendor": "vendor Limited Inc, California",
- "locked": true,
- "deleted": false,
- "encrypted": false,
- "id": 18
}, - {
- "createdBy": "bumlux",
- "createdAt": 1682408574920,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408574925,
- "name": "app runtime",
- "description": "Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1",
- "version": "1.0.25",
- "type": "runtime",
- "typeName": "runtime",
- "vendor": "vendor GmbH, Stuttgart, Germany",
- "locked": true,
- "deleted": false,
- "encrypted": false,
- "id": 17
}, - {
- "createdBy": "bumlux",
- "createdAt": 1682408574919,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408574926,
- "name": "application",
- "description": "Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1",
- "version": "1.0.67",
- "type": "application",
- "typeName": "Application",
- "vendor": "vendor Limited, California",
- "locked": true,
- "deleted": false,
- "encrypted": false,
- "id": 16
}
], - "requiredMigrationStep": false,
- "type": "test_default_ds_type",
- "typeName": "OS (FW) mandatory, runtime (FW) and app (SW) optional",
- "complete": true,
- "deleted": false,
- "valid": true,
- "_links": {
- "modules": {
}, - "metadata": {
}
}, - "id": 6
}
Handles the DELETE request for a single Distribution Set. Required permission: DELETE_REPOSITORY
distributionSetId required | integer <int64> |
{- "exceptionClass": "string",
- "errorCode": "string",
- "message": "string",
- "parameters": [
- "string"
]
}
Get a single meta data value for a meta data key. Required permission: READ_REPOSITORY
distributionSetId required | integer <int64> |
metadataKey required | string |
{- "key": "someKnownKey",
- "value": "someKnownKeyValue"
}
Update a single meta data value for speficic key. Required permission: UPDATE_REPOSITORY
distributionSetId required | integer <int64> |
metadataKey required | string |
value | string |
{- "value": "someValue"
}
{- "key": "someKnownKey",
- "value": "someKnownKeyValue"
}
Delete a single meta data. Required permission: UPDATE_REPOSITORY
distributionSetId required | integer <int64> |
metadataKey required | string |
{- "exceptionClass": "string",
- "errorCode": "string",
- "message": "string",
- "parameters": [
- "string"
]
}
Handles the GET request of retrieving all distribution sets. Required permission: READ_REPOSITORY
offset | string The paging offset (default is 0) |
limit | string The maximum number of entries in a page (default is 50) |
sort | string The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result. |
q | string Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields. |
{- "content": [
- {
- "createdBy": "bumlux",
- "createdAt": 1682408574924,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408574925,
- "name": "DS",
- "description": "Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1",
- "version": "1.0",
- "modules": [
- {
- "createdBy": "bumlux",
- "createdAt": 1682408574921,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408574926,
- "name": "Firmware",
- "description": "Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1",
- "version": "1.0.42",
- "type": "os",
- "typeName": "OS",
- "vendor": "vendor Limited Inc, California",
- "locked": true,
- "deleted": false,
- "encrypted": false,
- "id": 18
}, - {
- "createdBy": "bumlux",
- "createdAt": 1682408574920,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408574925,
- "name": "app runtime",
- "description": "Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1",
- "version": "1.0.25",
- "type": "runtime",
- "typeName": "runtime",
- "vendor": "vendor GmbH, Stuttgart, Germany",
- "locked": true,
- "deleted": false,
- "encrypted": false,
- "id": 17
}, - {
- "createdBy": "bumlux",
- "createdAt": 1682408574919,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408574926,
- "name": "application",
- "description": "Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1",
- "version": "1.0.67",
- "type": "application",
- "typeName": "Application",
- "vendor": "vendor Limited, California",
- "locked": true,
- "deleted": false,
- "encrypted": false,
- "id": 16
}
], - "requiredMigrationStep": false,
- "type": "test_default_ds_type",
- "typeName": "OS (FW) mandatory, runtime (FW) and app (SW) optional",
- "complete": true,
- "deleted": false,
- "valid": true,
- "_links": {
- "modules": {
}, - "metadata": {
}
}, - "id": 6
}
], - "total": 0,
- "size": 0,
- "_links": {
- "property1": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}, - "property2": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}
}
}
Handles the POST request of creating new distribution sets within Hawkbit. The request body must always be a list of sets. Required permission: CREATE_REPOSITORY
name | string The name of the entity |
description | string The description of the entity |
version | string Package version |
locked | boolean Should be set only if change of locked state is requested. If put, the distribution set locked flag will be set to the requested. Note: unlock (i.e. set this property to false) with extreme care! In general once distribution set is locked it shall not be unlocked. Note that it could have been assigned / deployed to targets. |
requiredMigrationStep | boolean True if DS is a required migration step for another DS. As a result the DS’s assignment will not be cancelled when another DS is assigned (note: updatable only if DS is not yet assigned to a target) |
Array of objects (MgmtSoftwareModuleAssigment) | |
type | string The type of the distribution set |
[- {
- "name": "dsOne",
- "description": "Description of the distribution set.",
- "version": "1.0.0",
- "locked": true,
- "requiredMigrationStep": false,
- "modules": [
- {
- "id": 108
}
], - "type": "test_default_ds_type"
}
]
[- {
- "createdBy": "bumlux",
- "createdAt": 1682408574924,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408574925,
- "name": "DS",
- "description": "Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1",
- "version": "1.0",
- "modules": [
- {
- "createdBy": "bumlux",
- "createdAt": 1682408574921,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408574926,
- "name": "Firmware",
- "description": "Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1",
- "version": "1.0.42",
- "type": "os",
- "typeName": "OS",
- "vendor": "vendor Limited Inc, California",
- "locked": true,
- "deleted": false,
- "encrypted": false,
- "id": 18
}, - {
- "createdBy": "bumlux",
- "createdAt": 1682408574920,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408574925,
- "name": "app runtime",
- "description": "Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1",
- "version": "1.0.25",
- "type": "runtime",
- "typeName": "runtime",
- "vendor": "vendor GmbH, Stuttgart, Germany",
- "locked": true,
- "deleted": false,
- "encrypted": false,
- "id": 17
}, - {
- "createdBy": "bumlux",
- "createdAt": 1682408574919,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408574926,
- "name": "application",
- "description": "Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1",
- "version": "1.0.67",
- "type": "application",
- "typeName": "Application",
- "vendor": "vendor Limited, California",
- "locked": true,
- "deleted": false,
- "encrypted": false,
- "id": 16
}
], - "requiredMigrationStep": false,
- "type": "test_default_ds_type",
- "typeName": "OS (FW) mandatory, runtime (FW) and app (SW) optional",
- "complete": true,
- "deleted": false,
- "valid": true,
- "_links": {
- "modules": {
}, - "metadata": {
}
}, - "id": 6
}
]
Get a paged list of meta data for a distribution set. Required permission: READ_REPOSITORY
distributionSetId required | integer <int64> |
offset | string The paging offset (default is 0) |
limit | string The maximum number of entries in a page (default is 50) |
sort | string The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result. |
q | string Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields. |
{- "content": [
- {
- "key": "someKnownKey",
- "value": "someKnownKeyValue"
}
], - "total": 0,
- "size": 0,
- "_links": {
- "property1": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}, - "property2": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}
}
}
Create a list of meta data entries Required permissions: READ_REPOSITORY and UPDATE_TARGET
distributionSetId required | integer <int64> |
key required | string Metadata property key |
value | string Metadata property value |
[- {
- "key": "someKnownKey",
- "value": "someKnownKeyValue"
}
]
[- {
- "key": "someKnownKey",
- "value": "someKnownKeyValue"
}
]
Invalidate a distribution set. Once a distribution set is invalidated, it can not be valid again. An invalidated distribution set cannot be assigned to targets anymore. The distribution set that is going to be invalidated will be removed from all auto assignments. Furthermore, the user can choose to cancel all rollouts and (force) cancel all actions connected to this distribution set. Required permission: UPDATE_REPOSITORY, UPDATE_TARGET
distributionSetId required | integer <int64> |
actionCancelationType required | string Enum: "soft" "force" "none" Type of cancelation for actions referring to the given distribution set |
cancelRollouts | boolean Defines if rollouts referring to this distribution set should be canceled |
{- "actionCancelationType": "soft",
- "cancelRollouts": true
}
{- "exceptionClass": "string",
- "errorCode": "string",
- "message": "string",
- "parameters": [
- "string"
]
}
Handles the GET request for retrieving assigned targets of a single distribution set. Required permissions: READ_REPOSITORY and READ_TARGET
distributionSetId required | integer <int64> |
offset | string The paging offset (default is 0) |
limit | string The maximum number of entries in a page (default is 50) |
sort | string The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result. |
q | string Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields. |
{- "content": [
- {
- "createdBy": "bumlux",
- "createdAt": 1682408577979,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408577988,
- "name": "137",
- "description": "My name is 137",
- "controllerId": "137",
- "updateStatus": "in_sync",
- "lastControllerRequestAt": 1682408577978,
- "installedAt": 1682408577987,
- "ipAddress": "192.168.0.1",
- "pollStatus": {
- "lastRequestAt": 1682408577978,
- "nextExpectedRequestAt": 1682451777978,
- "overdue": false
}, - "securityToken": "949f1c3487125467464a960d750373c1",
- "requestAttributes": true,
- "targetType": 13,
- "targetTypeName": "defaultType",
- "autoConfirmActive": false,
- "_links": {
- "actions": {
}, - "metadata": {
},
}
}
], - "total": 0,
- "size": 0,
- "_links": {
- "property1": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}, - "property2": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}
}
}
Handles the POST request for assigning multiple targets to a distribution set.The request body must always be a list of target IDs. Non-existing targets are silently ignored resulting in a valid response. Required permissions: READ_REPOSITORY and UPDATE_TARGET
distributionSetId required | integer <int64> |
offline | boolean |
id required | string The technical identifier of the entity |
forcetime | integer <int64> Forcetime in milliseconds |
type | string Enum: "soft" "forced" "timeforced" "downloadonly" The type of the assignment |
object (MgmtMaintenanceWindowRequestBody) Separation of download and install by defining a maintenance window for the installation | |
weight | integer <int32> Importance of the assignment |
confirmationRequired | boolean (Available with user consent flow active) Defines, if the confirmation is required for an action. Confirmation is required per default |
[- {
- "id": "target4",
- "forcetime": 1682408575278,
- "type": "soft",
- "maintenanceWindow": {
- "schedule": "10 12 14 3 8 ? 2023",
- "duration": "00:10:00",
- "timezone": "+00:00"
}, - "weight": 100,
- "confirmationRequired": true
}
]
{- "alreadyAssigned": 0,
- "assignedActions": [
- {
- "_links": {
- "property1": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}, - "property2": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}
}, - "id": 0
}
], - "_links": {
- "property1": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}, - "property2": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}
}, - "assigned": 0,
- "total": 0
}
Handles the GET request of retrieving a single distribution set. Required permission: READ_REPOSITORY
distributionSetId required | integer <int64> |
offset | string The paging offset (default is 0) |
limit | string The maximum number of entries in a page (default is 50) |
sort | string The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result. |
{- "content": [
- {
- "createdBy": "bumlux",
- "createdAt": 1682408572790,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408572791,
- "name": "os",
- "description": "a description",
- "version": "1.0",
- "type": "os",
- "typeName": "OS",
- "vendor": "Vendor Limited, California",
- "encrypted": false,
- "locked": true,
- "deleted": false,
- "_links": {
- "metadata": {
}
}, - "id": 6
}
], - "total": 0,
- "size": 0,
- "_links": {
- "property1": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}, - "property2": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}
}
}
Handles the POST request for assigning multiple software modules to a distribution set.The request body must always be a list of software module IDs. Required permissions: READ_REPOSITORY and UPDATE_REPOSITORY
distributionSetId required | integer <int64> |
id | integer <int64> |
[- {
- "id": 108
}
]
{- "exceptionClass": "string",
- "errorCode": "string",
- "message": "string",
- "parameters": [
- "string"
]
}
Handles the GET request of retrieving Rollouts, Actions and Auto Assignments counts by Status for Distribution Set
distributionSetId required | integer <int64> |
{- "totalAutoAssignments": 0,
- "actions": {
- "property1": 0,
- "property2": 0
}, - "rollouts": {
- "property1": 0,
- "property2": 0
}
}
Handles the GET request of retrieving Rollouts count by Status for Distribution Set
distributionSetId required | integer <int64> |
{- "totalAutoAssignments": 0,
- "actions": {
- "property1": 0,
- "property2": 0
}, - "rollouts": {
- "property1": 0,
- "property2": 0
}
}
Handles the GET request of retrieving Auto Assignments count for Distribution Set
distributionSetId required | integer <int64> |
{- "totalAutoAssignments": 0,
- "actions": {
- "property1": 0,
- "property2": 0
}, - "rollouts": {
- "property1": 0,
- "property2": 0
}
}
Handles the GET request of retrieving Actions count by Status for Distribution Set
distributionSetId required | integer <int64> |
{- "totalAutoAssignments": 0,
- "actions": {
- "property1": 0,
- "property2": 0
}, - "rollouts": {
- "property1": 0,
- "property2": 0
}
}
Handles the GET request for retrieving installed targets of a single distribution set. Required permissions: READ_REPOSITORY and READ_TARGET
distributionSetId required | integer <int64> |
offset | string The paging offset (default is 0) |
limit | string The maximum number of entries in a page (default is 50) |
sort | string The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result. |
q | string Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields. |
{- "content": [
- {
- "createdBy": "bumlux",
- "createdAt": 1682408577979,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408577988,
- "name": "137",
- "description": "My name is 137",
- "controllerId": "137",
- "updateStatus": "in_sync",
- "lastControllerRequestAt": 1682408577978,
- "installedAt": 1682408577987,
- "ipAddress": "192.168.0.1",
- "pollStatus": {
- "lastRequestAt": 1682408577978,
- "nextExpectedRequestAt": 1682451777978,
- "overdue": false
}, - "securityToken": "949f1c3487125467464a960d750373c1",
- "requestAttributes": true,
- "targetType": 13,
- "targetTypeName": "defaultType",
- "autoConfirmActive": false,
- "_links": {
- "actions": {
}, - "metadata": {
},
}
}
], - "total": 0,
- "size": 0,
- "_links": {
- "property1": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}, - "property2": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}
}
}
Handles the GET request for retrieving assigned target filter queries of a single distribution set. Required permissions: READ_REPOSITORY and READ_TARGET
distributionSetId required | integer <int64> |
offset | string The paging offset (default is 0) |
limit | string The maximum number of entries in a page (default is 50) |
sort | string The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result. |
q | string Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields. |
{- "content": [
- {
- "createdBy": "bumlux",
- "createdAt": 1682408566380,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408566385,
- "name": "filter1",
- "query": "name==*",
- "autoAssignDistributionSet": 3,
- "autoAssignActionType": "forced",
- "autoAssignWeight": null,
- "confirmationRequired": null,
- "_links": {
}, - "id": 5
}
], - "total": 0,
- "size": 0,
- "_links": {
- "property1": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}, - "property2": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}
}
}
Delete an assignment. Required permission: UPDATE_REPOSITORY
distributionSetId required | integer <int64> |
softwareModuleId required | integer <int64> |
{- "exceptionClass": "string",
- "errorCode": "string",
- "message": "string",
- "parameters": [
- "string"
]
}
Handles the GET request of retrieving a single target. Required Permission: READ_TARGET.
targetId required | string |
{- "createdBy": "bumlux",
- "createdAt": 1682408577979,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408577988,
- "name": "137",
- "description": "My name is 137",
- "controllerId": "137",
- "updateStatus": "in_sync",
- "lastControllerRequestAt": 1682408577978,
- "installedAt": 1682408577987,
- "ipAddress": "192.168.0.1",
- "pollStatus": {
- "lastRequestAt": 1682408577978,
- "nextExpectedRequestAt": 1682451777978,
- "overdue": false
}, - "securityToken": "949f1c3487125467464a960d750373c1",
- "requestAttributes": true,
- "targetType": 13,
- "targetTypeName": "defaultType",
- "autoConfirmActive": false,
- "_links": {
- "actions": {
}, - "metadata": {
},
}
}
Handles the PUT request of updating a target. Required Permission: UPDATE_TARGET
targetId required | string |
name required | string The name of the entity |
description | string The description of the entity |
controllerId required | string Controller ID |
address | string The last known address URI of the target. Includes information of the target is connected either directly (DDI) through HTTP or indirectly (DMF) through amqp |
securityToken | string Pre-Shared key that allows targets to authenticate at Direct Device Integration API if enabled in the tenant settings |
requestAttributes | boolean Request re-transmission of target attributes |
targetType | integer <int64> ID of the target type |
{- "name": "controllerName",
- "description": "Example description of a target",
- "controllerId": "123",
- "securityToken": "2345678DGGDGFTDzztgf",
- "requestAttributes": true,
- "targetType": 10
}
{- "createdBy": "bumlux",
- "createdAt": 1682408577979,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408577988,
- "name": "137",
- "description": "My name is 137",
- "controllerId": "137",
- "updateStatus": "in_sync",
- "lastControllerRequestAt": 1682408577978,
- "installedAt": 1682408577987,
- "ipAddress": "192.168.0.1",
- "pollStatus": {
- "lastRequestAt": 1682408577978,
- "nextExpectedRequestAt": 1682451777978,
- "overdue": false
}, - "securityToken": "949f1c3487125467464a960d750373c1",
- "requestAttributes": true,
- "targetType": 13,
- "targetTypeName": "defaultType",
- "autoConfirmActive": false,
- "_links": {
- "actions": {
}, - "metadata": {
},
}
}
Handles the DELETE request of deleting a single target. Required Permission: DELETE_TARGET
targetId required | string |
{- "exceptionClass": "string",
- "errorCode": "string",
- "message": "string",
- "parameters": [
- "string"
]
}
Get a single meta data value for a meta data key. Required permission: READ_REPOSITORY
targetId required | string |
metadataKey required | string |
{- "key": "someKnownKey",
- "value": "someKnownKeyValue"
}
Update a single meta data value for speficic key. Required permission: UPDATE_REPOSITORY
targetId required | string |
metadataKey required | string |
value | string |
{- "value": "someValue"
}
{- "key": "someKnownKey",
- "value": "someKnownKeyValue"
}
Delete a single meta data. Required permission: UPDATE_REPOSITORY
targetId required | string |
metadataKey required | string |
{- "exceptionClass": "string",
- "errorCode": "string",
- "message": "string",
- "parameters": [
- "string"
]
}
Handles the GET request of retrieving a specific action on a specific target. Required Permission: READ_TARGET
targetId required | string |
actionId required | integer <int64> |
{- "createdBy": "bumlux",
- "createdAt": 1682408571231,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408571265,
- "type": "update",
- "status": "finished",
- "detailStatus": "finished",
- "rollout": 1,
- "rolloutName": "rollout",
- "_links": {
- "target": {
- "name": "target137"
}, - "distributionset": {
- "name": "DS:1.0"
},
}, - "id": 1,
- "forceType": "forced"
}
Handles the PUT request to switch an action from soft to forced. Required Permission: UPDATE_TARGET.
targetId required | string |
actionId required | integer <int64> |
forceType | string Enum: "soft" "forced" "timeforced" "downloadonly" |
{- "forceType": "soft"
}
{- "createdBy": "bumlux",
- "createdAt": 1682408571231,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408571265,
- "type": "update",
- "status": "finished",
- "detailStatus": "finished",
- "rollout": 1,
- "rolloutName": "rollout",
- "_links": {
- "target": {
- "name": "target137"
}, - "distributionset": {
- "name": "DS:1.0"
},
}, - "id": 1,
- "forceType": "forced"
}
Cancels an active action, only active actions can be deleted. Required Permission: UPDATE_TARGET
targetId required | string |
actionId required | integer <int64> |
force | boolean Default: false |
{- "exceptionClass": "string",
- "errorCode": "string",
- "message": "string",
- "parameters": [
- "string"
]
}
Handles the GET request of retrieving all targets. Required permission: READ_TARGET
offset | string The paging offset (default is 0) |
limit | string The maximum number of entries in a page (default is 50) |
sort | string The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result. |
q | string Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields. |
{- "content": [
- {
- "createdBy": "bumlux",
- "createdAt": 1682408577979,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408577988,
- "name": "137",
- "description": "My name is 137",
- "controllerId": "137",
- "updateStatus": "in_sync",
- "lastControllerRequestAt": 1682408577978,
- "installedAt": 1682408577987,
- "ipAddress": "192.168.0.1",
- "pollStatus": {
- "lastRequestAt": 1682408577978,
- "nextExpectedRequestAt": 1682451777978,
- "overdue": false
}, - "securityToken": "949f1c3487125467464a960d750373c1",
- "requestAttributes": true,
- "targetType": 13,
- "targetTypeName": "defaultType",
- "autoConfirmActive": false,
- "_links": {
- "actions": {
}, - "metadata": {
},
}
}
], - "total": 0,
- "size": 0,
- "_links": {
- "property1": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}, - "property2": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}
}
}
Handles the POST request of creating new targets. The request body must always be a list of targets. Required Permission: CREATE_TARGET
name required | string The name of the entity |
description | string The description of the entity |
controllerId required | string Controller ID |
address | string The last known address URI of the target. Includes information of the target is connected either directly (DDI) through HTTP or indirectly (DMF) through amqp |
securityToken | string Pre-Shared key that allows targets to authenticate at Direct Device Integration API if enabled in the tenant settings |
requestAttributes | boolean Request re-transmission of target attributes |
targetType | integer <int64> ID of the target type |
[- {
- "name": "controllerName",
- "description": "Example description of a target",
- "controllerId": "123",
- "securityToken": "2345678DGGDGFTDzztgf",
- "requestAttributes": true,
- "targetType": 10
}
]
[- {
- "createdBy": "bumlux",
- "createdAt": 1682408577979,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408577988,
- "name": "137",
- "description": "My name is 137",
- "controllerId": "137",
- "updateStatus": "in_sync",
- "lastControllerRequestAt": 1682408577978,
- "installedAt": 1682408577987,
- "ipAddress": "192.168.0.1",
- "pollStatus": {
- "lastRequestAt": 1682408577978,
- "nextExpectedRequestAt": 1682451777978,
- "overdue": false
}, - "securityToken": "949f1c3487125467464a960d750373c1",
- "requestAttributes": true,
- "targetType": 13,
- "targetTypeName": "defaultType",
- "autoConfirmActive": false,
- "_links": {
- "actions": {
}, - "metadata": {
},
}
}
]
Assign or update the target type of a target. Required permission: UPDATE_TARGET
targetId required | string |
id | integer <int64> |
{- "id": 108
}
{- "exceptionClass": "string",
- "errorCode": "string",
- "message": "string",
- "parameters": [
- "string"
]
}
Remove the target type from a target. The target type will be set to null. Required permission: UPDATE_TARGET
targetId required | string |
{- "exceptionClass": "string",
- "errorCode": "string",
- "message": "string",
- "parameters": [
- "string"
]
}
Get a paged list of meta data for a target. Required permission: READ_REPOSITORY
targetId required | string |
offset | string The paging offset (default is 0) |
limit | string The maximum number of entries in a page (default is 50) |
sort | string The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result. |
q | string Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields. |
{- "content": [
- {
- "key": "someKnownKey",
- "value": "someKnownKeyValue"
}
], - "total": 0,
- "size": 0,
- "_links": {
- "property1": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}, - "property2": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}
}
}
Create a list of meta data entries Required permissions: READ_REPOSITORY and UPDATE_TARGET
targetId required | string |
key required | string Metadata property key |
value | string Metadata property value |
[- {
- "key": "someKnownKey",
- "value": "someKnownKeyValue"
}
]
[- {
- "key": "someKnownKey",
- "value": "someKnownKeyValue"
}
]
Handles the POST request to deactivate auto-confirmation for a specific target. All active actions will remain unchanged while all future actions need to be confirmed, before processing with the deployment. Required Permission: UPDATE_TARGET
targetId required | string |
{- "exceptionClass": "string",
- "errorCode": "string",
- "message": "string",
- "parameters": [
- "string"
]
}
Handles the POST request to activate auto-confirmation for a specific target. As a result all current active as well as future actions will automatically be confirmed by mentioning the initiator as triggered person. Actions will be automatically confirmed, as long as auto-confirmation is active. Required Permission: UPDATE_TARGET
targetId required | string |
initiator | string (Optional) Initiator set on activation |
remark | string (Optional) Remark set on activation |
{- "initiator": "custom_initiator_value",
- "remark": "custom_remark"
}
{- "exceptionClass": "string",
- "errorCode": "string",
- "message": "string",
- "parameters": [
- "string"
]
}
Handles the GET request of retrieving the assigned distribution set of an specific target. Required Permission: READ_TARGET
targetId required | string |
{- "createdBy": "bumlux",
- "createdAt": 1682408574924,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408574925,
- "name": "DS",
- "description": "Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1",
- "version": "1.0",
- "modules": [
- {
- "createdBy": "bumlux",
- "createdAt": 1682408574921,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408574926,
- "name": "Firmware",
- "description": "Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1",
- "version": "1.0.42",
- "type": "os",
- "typeName": "OS",
- "vendor": "vendor Limited Inc, California",
- "locked": true,
- "deleted": false,
- "encrypted": false,
- "id": 18
}, - {
- "createdBy": "bumlux",
- "createdAt": 1682408574920,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408574925,
- "name": "app runtime",
- "description": "Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1",
- "version": "1.0.25",
- "type": "runtime",
- "typeName": "runtime",
- "vendor": "vendor GmbH, Stuttgart, Germany",
- "locked": true,
- "deleted": false,
- "encrypted": false,
- "id": 17
}, - {
- "createdBy": "bumlux",
- "createdAt": 1682408574919,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408574926,
- "name": "application",
- "description": "Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1",
- "version": "1.0.67",
- "type": "application",
- "typeName": "Application",
- "vendor": "vendor Limited, California",
- "locked": true,
- "deleted": false,
- "encrypted": false,
- "id": 16
}
], - "requiredMigrationStep": false,
- "type": "test_default_ds_type",
- "typeName": "OS (FW) mandatory, runtime (FW) and app (SW) optional",
- "complete": true,
- "deleted": false,
- "valid": true,
- "_links": {
- "modules": {
}, - "metadata": {
}
}, - "id": 6
}
Handles the POST request for assigning a distribution set to a specific target. Required Permission: READ_REPOSITORY and UPDATE_TARGET
targetId required | string |
offline | string Offline update (set param to true) that is only reported but not managed by the service, e.g. defaults set in factory, manual updates or migrations from other update systems. A completed action is added to the history of the target(s). Target is set to IN_SYNC state as both assigned and installed DS are set. Note: only executed if the target has currently no running update |
id required | integer <int64> |
forcetime | integer <int64> Forcetime in milliseconds |
weight | integer <int32> Importance of the assignment |
confirmationRequired | boolean (Available with user consent flow active) Specifies if the confirmation by the device is required for this action |
type | string Enum: "soft" "forced" "timeforced" "downloadonly" The type of the assignment |
object (MgmtMaintenanceWindowRequestBody) Separation of download and install by defining a maintenance window for the installation |
[- {
- "id": 108,
- "forcetime": 1691065930359,
- "weight": 23,
- "confirmationRequired": false,
- "type": "soft",
- "maintenanceWindow": {
- "schedule": "10 12 14 3 8 ? 2023",
- "duration": "00:10:00",
- "timezone": "+00:00"
}
}
]
{- "alreadyAssigned": 0,
- "assignedActions": [
- {
- "_links": {
- "property1": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}, - "property2": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}
}, - "id": 0
}
], - "_links": {
- "property1": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}, - "property2": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}
}, - "assigned": 0,
- "total": 0
}
Get a paged list of tags for a target. Required permission: READ_REPOSITORY
targetId required | string |
[- {
- "createdBy": "bumlux",
- "createdAt": 1682408561990,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408561992,
- "name": "DsTag",
- "description": "My name is DsTag",
- "colour": "default",
- "_links": {
- "assignedDistributionSets": {
}
}, - "id": 6
}
]
Handles the GET request of retrieving the installed distribution set of an specific target. Required Permission: READ_TARGET
targetId required | string |
{- "createdBy": "bumlux",
- "createdAt": 1682408574924,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408574925,
- "name": "DS",
- "description": "Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1",
- "version": "1.0",
- "modules": [
- {
- "createdBy": "bumlux",
- "createdAt": 1682408574921,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408574926,
- "name": "Firmware",
- "description": "Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1",
- "version": "1.0.42",
- "type": "os",
- "typeName": "OS",
- "vendor": "vendor Limited Inc, California",
- "locked": true,
- "deleted": false,
- "encrypted": false,
- "id": 18
}, - {
- "createdBy": "bumlux",
- "createdAt": 1682408574920,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408574925,
- "name": "app runtime",
- "description": "Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1",
- "version": "1.0.25",
- "type": "runtime",
- "typeName": "runtime",
- "vendor": "vendor GmbH, Stuttgart, Germany",
- "locked": true,
- "deleted": false,
- "encrypted": false,
- "id": 17
}, - {
- "createdBy": "bumlux",
- "createdAt": 1682408574919,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408574926,
- "name": "application",
- "description": "Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1",
- "version": "1.0.67",
- "type": "application",
- "typeName": "Application",
- "vendor": "vendor Limited, California",
- "locked": true,
- "deleted": false,
- "encrypted": false,
- "id": 16
}
], - "requiredMigrationStep": false,
- "type": "test_default_ds_type",
- "typeName": "OS (FW) mandatory, runtime (FW) and app (SW) optional",
- "complete": true,
- "deleted": false,
- "valid": true,
- "_links": {
- "modules": {
}, - "metadata": {
}
}, - "id": 6
}
Handles the GET request to check the current auto-confirmation state of a target. Required Permission: READ_TARGET
targetId required | string |
{- "active": true,
- "initiator": "custom_initiator_value",
- "remark": "custom_remark",
- "activatedAt": 1682408577704,
- "_links": {
- "deactivate": {
}
}
}
Handles the GET request of retrieving the attributes of a specific target. Reponse is a key/value list. Required Permission: READ_TARGET
targetId required | string |
{- "property1": "string",
- "property2": "string"
}
Handles the GET request of retrieving the full action history of a specific target. Required Permission: READ_TARGET
targetId required | string |
offset | string The paging offset (default is 0) |
limit | string The maximum number of entries in a page (default is 50) |
sort | string The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result. |
q | string Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields. |
{- "content": [
- {
- "createdBy": "bumlux",
- "createdAt": 1682408571231,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408571265,
- "type": "update",
- "status": "finished",
- "detailStatus": "finished",
- "rollout": 1,
- "rolloutName": "rollout",
- "_links": {
- "target": {
- "name": "target137"
}, - "distributionset": {
- "name": "DS:1.0"
},
}, - "id": 1,
- "forceType": "forced"
}
], - "total": 0,
- "size": 0,
- "_links": {
- "property1": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}, - "property2": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}
}
}
Handles the GET request of retrieving a specific action on a specific target. Required Permission: READ_TARGET
targetId required | string |
actionId required | integer <int64> |
offset | integer <int32> Default: 0 |
limit | integer <int32> Default: 50 |
sort | string |
{- "content": [
- {
- "type": "running",
- "messages": [
- "string"
], - "reportedAt": 1691065929524,
- "code": 200,
- "id": 21
}
], - "total": 0,
- "size": 0,
- "_links": {
- "property1": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}, - "property2": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}
}
}
Handles the GET request of retrieving all actions.
offset | string The paging offset (default is 0) |
limit | string The maximum number of entries in a page (default is 50) |
sort | string The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result. |
q | string Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields. |
representation | string The representation mode. Can be "full" or "compact". Defaults to "compact" |
{- "content": [
- {
- "createdBy": "bumlux",
- "createdAt": 1682408571231,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408571265,
- "type": "update",
- "status": "finished",
- "detailStatus": "finished",
- "rollout": 1,
- "rolloutName": "rollout",
- "_links": {
- "target": {
- "name": "target137"
}, - "distributionset": {
- "name": "DS:1.0"
},
}, - "id": 1,
- "forceType": "forced"
}
], - "total": 0,
- "size": 0,
- "_links": {
- "property1": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}, - "property2": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}
}
}
Handles the GET request of retrieving a single action by actionId.
actionId required | integer <int64> |
{- "createdBy": "bumlux",
- "createdAt": 1682408571231,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408571265,
- "type": "update",
- "status": "finished",
- "detailStatus": "finished",
- "rollout": 1,
- "rolloutName": "rollout",
- "_links": {
- "target": {
- "name": "target137"
}, - "distributionset": {
- "name": "DS:1.0"
},
}, - "id": 1,
- "forceType": "forced"
}
Handles the GET request of retrieving a single software module type. Required Permission: READ_REPOSITORY
softwareModuleTypeId required | integer <int64> |
{- "createdBy": "system",
- "createdAt": 1682408579390,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408579394,
- "name": "Application",
- "description": "Updated description.",
- "key": "application",
- "maxAssignments": 2147483647,
- "deleted": false,
- "id": 4
}
Handles the PUT request for a single software module type. Required Permission: UPDATE_REPOSITORY
softwareModuleTypeId required | integer <int64> |
description | string |
colour | string |
{- "description": "Example description",
- "colour": "rgb(0,0,255"
}
{- "createdBy": "system",
- "createdAt": 1682408579390,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408579394,
- "name": "Application",
- "description": "Updated description.",
- "key": "application",
- "maxAssignments": 2147483647,
- "deleted": false,
- "id": 4
}
Handles the DELETE request for a single software module type. Required Permission: DELETE_REPOSITORY
softwareModuleTypeId required | integer <int64> |
{- "exceptionClass": "string",
- "errorCode": "string",
- "message": "string",
- "parameters": [
- "string"
]
}
Handles the GET request of retrieving all software module types. Required Permission: READ_REPOSITORY
offset | string The paging offset (default is 0) |
limit | string The maximum number of entries in a page (default is 50) |
sort | string The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result. |
q | string Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields. |
{- "content": [
- {
- "createdBy": "system",
- "createdAt": 1682408579390,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408579394,
- "name": "Application",
- "description": "Updated description.",
- "key": "application",
- "maxAssignments": 2147483647,
- "deleted": false,
- "id": 4
}
], - "total": 0,
- "size": 0,
- "_links": {
- "property1": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}, - "property2": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}
}
}
Handles the POST request of creating new software module types. The request body must always be a list of module types. Required Permission: CREATE_REPOSITORY
description | string |
colour | string |
name required | string |
key required | string |
maxAssignments | integer <int32> |
[- {
- "description": "Example description",
- "colour": "rgb(0,0,255",
- "name": "Example name",
- "key": "Example key",
- "maxAssignments": 1
}
]
[- {
- "createdBy": "system",
- "createdAt": 1682408579390,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408579394,
- "name": "Application",
- "description": "Updated description.",
- "key": "application",
- "maxAssignments": 2147483647,
- "deleted": false,
- "id": 4
}
]
Handles the GET request of retrieving a single rollout. Required Permission: READ_ROLLOUT
rolloutId required | integer <int64> |
{- "createdBy": "bumlux",
- "createdAt": 1682408568812,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408568812,
- "name": "exampleRollout",
- "description": "Rollout for all named targets",
- "targetFilterQuery": "id==targets-*",
- "distributionSetId": 6,
- "status": "creating",
- "totalTargets": 20,
- "totalTargetsPerStatus": {
- "running": 0,
- "notstarted": 20,
- "scheduled": 0,
- "cancelled": 0,
- "finished": 0,
- "error": 0
}, - "totalGroups": 5,
- "startAt": 1682408570791,
- "forcetime": 1682408571791,
- "deleted": false,
- "type": "forced",
- "_links": {
- "triggerNextGroup": {
}, - "groups": {
}, - "distributionset": {
- "name": "bd3a71cb-6c8f-445c-adbb-e221414dcd96:1.0"
},
}, - "id": 6
}
Handles the UPDATE request for a single Rollout. Required permission: UPDATE_ROLLOUT
rolloutId required | integer <int64> |
name required | string |
description | string |
object (Links) |
{- "name": "exampleRollout",
- "description": "Rollout for all named targets"
}
{- "createdBy": "bumlux",
- "createdAt": 1682408568812,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408568812,
- "name": "exampleRollout",
- "description": "Rollout for all named targets",
- "targetFilterQuery": "id==targets-*",
- "distributionSetId": 6,
- "status": "creating",
- "totalTargets": 20,
- "totalTargetsPerStatus": {
- "running": 0,
- "notstarted": 20,
- "scheduled": 0,
- "cancelled": 0,
- "finished": 0,
- "error": 0
}, - "totalGroups": 5,
- "startAt": 1682408570791,
- "forcetime": 1682408571791,
- "deleted": false,
- "type": "forced",
- "_links": {
- "triggerNextGroup": {
}, - "groups": {
}, - "distributionset": {
- "name": "bd3a71cb-6c8f-445c-adbb-e221414dcd96:1.0"
},
}, - "id": 6
}
Handles the DELETE request of deleting a rollout. Required Permission: DELETE_ROLLOUT
rolloutId required | integer <int64> |
{- "exceptionClass": "string",
- "errorCode": "string",
- "message": "string",
- "parameters": [
- "string"
]
}
Handles the GET request of retrieving all rollouts. Required Permission: READ_ROLLOUT
offset | string The paging offset (default is 0) |
limit | string The maximum number of entries in a page (default is 50) |
sort | string The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result. |
q | string Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields. |
representation | string Default: "compact" |
{- "content": [
- {
- "createdBy": "bumlux",
- "createdAt": 1682408568812,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408568812,
- "name": "exampleRollout",
- "description": "Rollout for all named targets",
- "targetFilterQuery": "id==targets-*",
- "distributionSetId": 6,
- "status": "creating",
- "totalTargets": 20,
- "totalTargetsPerStatus": {
- "running": 0,
- "notstarted": 20,
- "scheduled": 0,
- "cancelled": 0,
- "finished": 0,
- "error": 0
}, - "totalGroups": 5,
- "startAt": 1682408570791,
- "forcetime": 1682408571791,
- "deleted": false,
- "type": "forced",
- "_links": {
- "triggerNextGroup": {
}, - "groups": {
}, - "distributionset": {
- "name": "bd3a71cb-6c8f-445c-adbb-e221414dcd96:1.0"
},
}, - "id": 6
}
], - "total": 0,
- "size": 0,
- "_links": {
- "property1": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}, - "property2": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}
}
}
Handles the POST request of creating new rollout. Required Permission: CREATE_ROLLOUT
name required | string |
description | string |
object (MgmtRolloutCondition) The error condition which takes in place to evaluate if a rollout group encounter errors | |
object (MgmtRolloutSuccessAction) The success action which takes in place to execute in case the success action is fulfilled | |
object (MgmtRolloutCondition) The error condition which takes in place to evaluate if a rollout group encounter errors | |
object (MgmtRolloutErrorAction) The error action which is executed if the error condition is fulfilled | |
targetFilterQuery | string Target filter query language expression |
distributionSetId | integer <int64> The ID of distribution set of this rollout |
amountGroups | integer <int32> The amount of groups the rollout should split targets into |
forcetime | integer <int64> Force time in milliseconds |
startAt | integer <int64> Start at timestamp of Rollout |
weight | integer <int32> Weight of the resulting Actions |
dynamic | boolean |
object (MgmtDynamicRolloutGroupTemplate) Template for dynamic groups (only if dynamic flag is true) | |
confirmationRequired | boolean (Available with user consent flow active) If the confirmation is required for this rollout. Value will be used if confirmation options are missing in the rollout group definitions. Confirmation is required per default |
type | string Enum: "soft" "forced" "timeforced" "downloadonly" The type of this rollout |
Array of objects (MgmtRolloutGroup) The list of group definitions | |
object (Links) |
{- "distributionSetId": 6,
- "targetFilterQuery": "id==targets-*",
- "description": "Rollout for all named targets",
- "amountGroups": 5,
- "type": "forced",
- "successCondition": {
- "condition": "THRESHOLD",
- "expression": "50"
}, - "successAction": {
- "expression": "",
- "action": "NEXTGROUP"
}, - "name": "exampleRollout",
- "forcetime": 1682408571791,
- "errorAction": {
- "expression": "",
- "action": "PAUSE"
}, - "confirmationRequired": false,
- "errorCondition": {
- "condition": "THRESHOLD",
- "expression": "80"
}, - "startAt": 1682408570791
}
{- "createdBy": "bumlux",
- "createdAt": 1682408568812,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408568812,
- "name": "exampleRollout",
- "description": "Rollout for all named targets",
- "targetFilterQuery": "id==targets-*",
- "distributionSetId": 6,
- "status": "creating",
- "totalTargets": 20,
- "totalTargetsPerStatus": {
- "running": 0,
- "notstarted": 20,
- "scheduled": 0,
- "cancelled": 0,
- "finished": 0,
- "error": 0
}, - "totalGroups": 5,
- "startAt": 1682408570791,
- "forcetime": 1682408571791,
- "deleted": false,
- "type": "forced",
- "_links": {
- "triggerNextGroup": {
}, - "groups": {
}, - "distributionset": {
- "name": "bd3a71cb-6c8f-445c-adbb-e221414dcd96:1.0"
},
}, - "id": 6
}
Handles the POST request of triggering the next group of a rollout. Required Permission: UPDATE_ROLLOUT
rolloutId required | integer <int64> |
{- "exceptionClass": "string",
- "errorCode": "string",
- "message": "string",
- "parameters": [
- "string"
]
}
Handles the POST request of starting a created rollout. Required Permission: HANDLE_ROLLOUT
rolloutId required | integer <int64> |
{- "exceptionClass": "string",
- "errorCode": "string",
- "message": "string",
- "parameters": [
- "string"
]
}
Handles the POST request of retrying a rollout. Required Permission: CREATE_ROLLOUT
rolloutId required | integer <int64> |
{- "createdBy": "bumlux",
- "createdAt": 1682408568812,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408568812,
- "name": "exampleRollout",
- "description": "Rollout for all named targets",
- "targetFilterQuery": "id==targets-*",
- "distributionSetId": 6,
- "status": "creating",
- "totalTargets": 20,
- "totalTargetsPerStatus": {
- "running": 0,
- "notstarted": 20,
- "scheduled": 0,
- "cancelled": 0,
- "finished": 0,
- "error": 0
}, - "totalGroups": 5,
- "startAt": 1682408570791,
- "forcetime": 1682408571791,
- "deleted": false,
- "type": "forced",
- "_links": {
- "triggerNextGroup": {
}, - "groups": {
}, - "distributionset": {
- "name": "bd3a71cb-6c8f-445c-adbb-e221414dcd96:1.0"
},
}, - "id": 6
}
Handles the POST request of resuming a paused rollout. Required Permission: HANDLE_ROLLOUT
rolloutId required | integer <int64> |
{- "exceptionClass": "string",
- "errorCode": "string",
- "message": "string",
- "parameters": [
- "string"
]
}
Handles the POST request of pausing a running rollout. Required Permission: HANDLE_ROLLOUT
rolloutId required | integer <int64> |
{- "exceptionClass": "string",
- "errorCode": "string",
- "message": "string",
- "parameters": [
- "string"
]
}
Handles the POST request of denying a created rollout. Only possible if approval workflow is enabled in system configuration and rollout is in state WAITING_FOR_APPROVAL. Required Permission: APPROVE_ROLLOUT
rolloutId required | integer <int64> |
remark | string |
{- "exceptionClass": "string",
- "errorCode": "string",
- "message": "string",
- "parameters": [
- "string"
]
}
Handles the POST request of approving a created rollout. Only possible if approval workflow is enabled in system configuration and rollout is in state WAITING_FOR_APPROVAL. Required Permission: APPROVE_ROLLOUT
rolloutId required | integer <int64> |
remark | string |
{- "exceptionClass": "string",
- "errorCode": "string",
- "message": "string",
- "parameters": [
- "string"
]
}
Handles the GET request of retrieving all deploy groups of a specific rollout. Required Permission: READ_ROLLOUT
rolloutId required | integer <int64> |
offset | string The paging offset (default is 0) |
limit | string The maximum number of entries in a page (default is 50) |
sort | string The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result. |
q | string Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields. |
representation | string Default: "compact" |
{- "content": [
- {
- "createdBy": "bumlux",
- "createdAt": 1682408569768,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408569795,
- "name": "group-1",
- "description": "group-1",
- "successCondition": {
- "condition": "THRESHOLD",
- "expression": "10"
}, - "successAction": {
- "action": "NEXTGROUP",
- "expression": ""
}, - "errorCondition": {
- "condition": "THRESHOLD",
- "expression": "50"
}, - "errorAction": {
- "action": "PAUSE",
- "expression": ""
}, - "targetFilterQuery": "",
- "targetPercentage": 20,
- "confirmationRequired": false,
- "status": "ready",
- "totalTargets": 4,
- "totalTargetsPerStatus": {
- "running": 0,
- "notstarted": 4,
- "scheduled": 0,
- "cancelled": 0,
- "finished": 0,
- "error": 0
}, - "_links": {
}, - "id": 78
}
], - "total": 0,
- "size": 0,
- "_links": {
- "property1": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}, - "property2": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}
}
}
Handles the GET request of a single deploy group of a specific rollout. Required Permission: READ_ROLLOUT
rolloutId required | integer <int64> |
groupId required | integer <int64> |
{- "createdBy": "bumlux",
- "createdAt": 1682408569768,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408569795,
- "name": "group-1",
- "description": "group-1",
- "successCondition": {
- "condition": "THRESHOLD",
- "expression": "10"
}, - "successAction": {
- "action": "NEXTGROUP",
- "expression": ""
}, - "errorCondition": {
- "condition": "THRESHOLD",
- "expression": "50"
}, - "errorAction": {
- "action": "PAUSE",
- "expression": ""
}, - "targetFilterQuery": "",
- "targetPercentage": 20,
- "confirmationRequired": false,
- "status": "ready",
- "totalTargets": 4,
- "totalTargetsPerStatus": {
- "running": 0,
- "notstarted": 4,
- "scheduled": 0,
- "cancelled": 0,
- "finished": 0,
- "error": 0
}, - "_links": {
}, - "id": 78
}
Handles the GET request of retrieving all targets of a single deploy group of a specific rollout. Required Permissions: READ_ROLLOUT, READ_TARGET.
rolloutId required | integer <int64> |
groupId required | integer <int64> |
offset | string The paging offset (default is 0) |
limit | string The maximum number of entries in a page (default is 50) |
sort | string The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result. |
q | string Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields. |
{- "content": [
- {
- "createdBy": "bumlux",
- "createdAt": 1682408577979,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408577988,
- "name": "137",
- "description": "My name is 137",
- "controllerId": "137",
- "updateStatus": "in_sync",
- "lastControllerRequestAt": 1682408577978,
- "installedAt": 1682408577987,
- "ipAddress": "192.168.0.1",
- "pollStatus": {
- "lastRequestAt": 1682408577978,
- "nextExpectedRequestAt": 1682451777978,
- "overdue": false
}, - "securityToken": "949f1c3487125467464a960d750373c1",
- "requestAttributes": true,
- "targetType": 13,
- "targetTypeName": "defaultType",
- "autoConfirmActive": false,
- "_links": {
- "actions": {
}, - "metadata": {
},
}
}
], - "total": 0,
- "size": 0,
- "_links": {
- "property1": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}, - "property2": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}
}
}
Handles the GET request of retrieving a single target type
targetTypeId required | integer <int64> |
{- "createdBy": "bumlux",
- "createdAt": 1682408564546,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408564546,
- "name": "TargetType",
- "description": "TargetType description",
- "colour": "#000000",
- "_links": {
- "compatibledistributionsettypes": {
}
}, - "id": 8
}
Handles the PUT request for a single target type. Required Permission: UPDATE_TARGET
targetTypeId required | integer <int64> |
name required | string The name of the entity |
description | string The description of the entity |
colour | string The colour of the entity |
{- "name": "updatedTypeName",
- "description": "an updated description",
- "colour": "#aaafff"
}
{- "createdBy": "bumlux",
- "createdAt": 1682408564546,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408564546,
- "name": "TargetType",
- "description": "TargetType description",
- "colour": "#000000",
- "_links": {
- "compatibledistributionsettypes": {
}
}, - "id": 8
}
Handles the DELETE request for a single target type. Required Permission: DELETE_TARGET
targetTypeId required | integer <int64> |
{- "exceptionClass": "string",
- "errorCode": "string",
- "message": "string",
- "parameters": [
- "string"
]
}
Handles the GET request of retrieving all target types.
offset | string The paging offset (default is 0) |
limit | string The maximum number of entries in a page (default is 50) |
sort | string The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result. |
q | string Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields. |
{- "content": [
- {
- "createdBy": "bumlux",
- "createdAt": 1682408564546,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408564546,
- "name": "TargetType",
- "description": "TargetType description",
- "colour": "#000000",
- "_links": {
- "compatibledistributionsettypes": {
}
}, - "id": 8
}
], - "total": 0,
- "size": 0,
- "_links": {
- "property1": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}, - "property2": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}
}
}
Handles the POST request for creating new target types. The request body must always be a list of types. Required Permission: CREATE_TARGET
name required | string The name of the entity |
description | string The description of the entity |
colour | string The colour of the entity |
key | string Target type key |
Array of objects (MgmtDistributionSetTypeAssignment) Array of distribution set types that are compatible to that target type |
[- {
- "name": "updatedTypeName",
- "description": "an updated description",
- "colour": "#aaafff",
- "key": "id.t23",
- "compatibledistributionsettypes": [
- {
- "id": 108
}
]
}
]
[- {
- "createdBy": "bumlux",
- "createdAt": 1682408564546,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408564546,
- "name": "TargetType",
- "description": "TargetType description",
- "colour": "#000000",
- "_links": {
- "compatibledistributionsettypes": {
}
}, - "id": 8
}
]
Handles the GET request of retrieving the list of compatible distribution set types in that target type. Required Permission: READ_TARGET, READ_REPOSITORY
targetTypeId required | integer <int64> |
[- {
- "createdBy": "bumlux",
- "createdAt": 1682408579418,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408579459,
- "name": "OS (FW) mandatory, runtime (FW) and app (SW) optional",
- "description": "Desc1234",
- "key": "test_default_ds_type",
- "deleted": false,
- "colour": "rgb(86,37,99)",
- "_links": {
- "mandatorymodules": {
}, - "optionalmodules": {
}
}, - "id": 14
}
]
Handles the POST request for adding compatible distribution set types to a target type. Required Permission: UPDATE_TARGET and READ_REPOSITORY
targetTypeId required | integer <int64> |
id | integer <int64> |
[- {
- "id": 108
}
]
{- "exceptionClass": "string",
- "errorCode": "string",
- "message": "string",
- "parameters": [
- "string"
]
}
Handles the DELETE request for removing a distribution set type from a single target type. Required Permission: UPDATE_TARGET and READ_REPOSITORY
targetTypeId required | integer <int64> |
distributionSetTypeId required | integer <int64> |
{- "exceptionClass": "string",
- "errorCode": "string",
- "message": "string",
- "parameters": [
- "string"
]
}
Handles the GET request of retrieving a single softwaremodule. Required Permission: READ_REPOSITORY
softwareModuleId required | integer <int64> |
{- "createdBy": "bumlux",
- "createdAt": 1682408572790,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408572791,
- "name": "os",
- "description": "a description",
- "version": "1.0",
- "type": "os",
- "typeName": "OS",
- "vendor": "Vendor Limited, California",
- "encrypted": false,
- "locked": true,
- "deleted": false,
- "_links": {
- "metadata": {
}
}, - "id": 6
}
Handles the PUT request for a single softwaremodule within Hawkbit. Required Permission: UPDATE_REPOSITORY
softwareModuleId required | integer <int64> |
description | string |
vendor | string |
locked | boolean Should be set only if change of locked state is requested. If put, the software module locked flag will be set to the requested. Note: unlock (i.e. set this property to false) with extreme care! In general once software module is locked it shall not be unlocked. Note that it could have been assigned / deployed to targets. |
{- "description": "SM Description",
- "vendor": "SM Vendor Name",
- "locked": true
}
{- "createdBy": "bumlux",
- "createdAt": 1682408572790,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408572791,
- "name": "os",
- "description": "a description",
- "version": "1.0",
- "type": "os",
- "typeName": "OS",
- "vendor": "Vendor Limited, California",
- "encrypted": false,
- "locked": true,
- "deleted": false,
- "_links": {
- "metadata": {
}
}, - "id": 6
}
Handles the DELETE request for a single softwaremodule within Hawkbit. Required Permission: DELETE_REPOSITORY
softwareModuleId required | integer <int64> |
{- "exceptionClass": "string",
- "errorCode": "string",
- "message": "string",
- "parameters": [
- "string"
]
}
Get a single meta data value for a meta data key. Required Permission: READ_REPOSITORY
softwareModuleId required | integer <int64> |
metadataKey required | string |
{- "key": "someKnownKey",
- "value": "someKnownValue",
- "targetVisible": false
}
Update a single meta data value for speficic key. Required Permission: UPDATE_REPOSITORY
softwareModuleId required | integer <int64> |
metadataKey required | string |
value | string |
targetVisible | boolean |
{- "value": "newValue",
- "targetVisible": true
}
{- "key": "someKnownKey",
- "value": "someKnownValue",
- "targetVisible": false
}
Delete a single meta data. Required Permission: UPDATE_REPOSITORY
softwareModuleId required | integer <int64> |
metadataKey required | string |
{- "exceptionClass": "string",
- "errorCode": "string",
- "message": "string",
- "parameters": [
- "string"
]
}
Handles the GET request of retrieving all softwaremodules. Required Permission: READ_REPOSITORY
offset | string The paging offset (default is 0) |
limit | string The maximum number of entries in a page (default is 50) |
sort | string The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result. |
q | string Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields. |
{- "content": [
- {
- "createdBy": "bumlux",
- "createdAt": 1682408572790,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408572791,
- "name": "os",
- "description": "a description",
- "version": "1.0",
- "type": "os",
- "typeName": "OS",
- "vendor": "Vendor Limited, California",
- "encrypted": false,
- "locked": true,
- "deleted": false,
- "_links": {
- "metadata": {
}
}, - "id": 6
}
], - "total": 0,
- "size": 0,
- "_links": {
- "property1": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}, - "property2": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}
}
}
Handles the POST request of creating new software modules. The request body must always be a list of modules. Required Permission: CREATE_REPOSITORY
name required | string |
version required | string |
type required | string |
description | string |
vendor | string |
encrypted | boolean |
[- {
- "name": "SM Name",
- "version": "1.0.0",
- "type": "os",
- "description": "SM Description",
- "vendor": "Vendor Limited, California",
- "encrypted": false
}
]
[- {
- "createdBy": "bumlux",
- "createdAt": 1682408572790,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408572791,
- "name": "os",
- "description": "a description",
- "version": "1.0",
- "type": "os",
- "typeName": "OS",
- "vendor": "Vendor Limited, California",
- "encrypted": false,
- "locked": true,
- "deleted": false,
- "_links": {
- "metadata": {
}
}, - "id": 6
}
]
Get a paged list of meta data for a software module. Required Permission: READ_REPOSITORY
softwareModuleId required | integer <int64> |
offset | string The paging offset (default is 0) |
limit | string The maximum number of entries in a page (default is 50) |
sort | string The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result. |
q | string Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields. |
{- "content": [
- {
- "key": "someKnownKey",
- "value": "someKnownValue",
- "targetVisible": false
}
], - "total": 0,
- "size": 0,
- "_links": {
- "property1": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}, - "property2": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}
}
}
Create a list of meta data entries Required Permission: UPDATE_REPOSITORY
softwareModuleId required | integer <int64> |
key required | string Metadata property key |
value | string Metadata property value |
targetVisible | boolean Metadata property is visible to targets as part of software update action |
[- {
- "key": "someKnownKey",
- "value": "someKnownValue",
- "targetVisible": false
}
]
[- {
- "key": "someKnownKey",
- "value": "someKnownValue",
- "targetVisible": false
}
]
Handles the GET request of retrieving all meta data of artifacts assigned to a software module. Required Permission: READ_REPOSITORY
softwareModuleId required | integer <int64> |
representation | string Default: "compact" |
useartifacturlhandler | boolean |
[- {
- "createdBy": "bumlux",
- "createdAt": 1682408572660,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408572660,
- "hashes": {
- "sha1": "70686514bec4a9f8188f88d470fb3d7999728fad",
- "md5": "f7c5b155e3636406cbc53c61f4692637",
- "sha256": "efbbd71e3aa3c1db9ff3905c81f1220adb0e5db3c5438732eedf98ab006ca742"
}, - "providedFilename": "origFilename",
- "size": 11,
- "_links": {
- "download": {
}
}, - "id": 1
}
]
Handles POST request for artifact upload. Required Permission: CREATE_REPOSITORY
softwareModuleId required | integer <int64> |
filename | string |
md5sum | string |
sha1sum | string |
sha256sum | string |
file required | string <binary> |
{- "createdBy": "bumlux",
- "createdAt": 1682408572660,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408572660,
- "hashes": {
- "sha1": "70686514bec4a9f8188f88d470fb3d7999728fad",
- "md5": "f7c5b155e3636406cbc53c61f4692637",
- "sha256": "efbbd71e3aa3c1db9ff3905c81f1220adb0e5db3c5438732eedf98ab006ca742"
}, - "providedFilename": "origFilename",
- "size": 11,
- "_links": {
- "download": {
}
}, - "id": 1
}
Handles the GET request of retrieving a single Artifact meta data request. Required Permission: READ_REPOSITORY
softwareModuleId required | integer <int64> |
artifactId required | integer <int64> |
useartifacturlhandler | boolean |
{- "createdBy": "bumlux",
- "createdAt": 1682408572660,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408572660,
- "hashes": {
- "sha1": "70686514bec4a9f8188f88d470fb3d7999728fad",
- "md5": "f7c5b155e3636406cbc53c61f4692637",
- "sha256": "efbbd71e3aa3c1db9ff3905c81f1220adb0e5db3c5438732eedf98ab006ca742"
}, - "providedFilename": "origFilename",
- "size": 11,
- "_links": {
- "download": {
}
}, - "id": 1
}
Handles the DELETE request for a single Artifact assigned to a SoftwareModule. Required Permission: DELETE_REPOSITORY
softwareModuleId required | integer <int64> |
artifactId required | integer <int64> |
{- "exceptionClass": "string",
- "errorCode": "string",
- "message": "string",
- "parameters": [
- "string"
]
}
Handles the GET request of retrieving a single target tag.
targetTagId required | integer <int64> |
{- "createdBy": "bumlux",
- "createdAt": 1682408561990,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408561992,
- "name": "DsTag",
- "description": "My name is DsTag",
- "colour": "default",
- "_links": {
- "assignedDistributionSets": {
}
}, - "id": 6
}
Handles the PUT request of updating a target tag.
targetTagId required | integer <int64> |
name | string The name of the entity |
description | string The description of the entity |
colour | string The colour of the entity |
{- "name": "Example name",
- "description": "Example description",
- "colour": "rgb(0,255,0)"
}
{- "createdBy": "bumlux",
- "createdAt": 1682408561990,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408561992,
- "name": "DsTag",
- "description": "My name is DsTag",
- "colour": "default",
- "_links": {
- "assignedDistributionSets": {
}
}, - "id": 6
}
Handles the GET request of retrieving a list of assigned targets.
targetTagId required | integer <int64> |
offset | string The paging offset (default is 0) |
limit | string The maximum number of entries in a page (default is 50) |
sort | string The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result. |
q | string Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields. |
{- "content": [
- {
- "createdBy": "bumlux",
- "createdAt": 1682408577979,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408577988,
- "name": "137",
- "description": "My name is 137",
- "controllerId": "137",
- "updateStatus": "in_sync",
- "lastControllerRequestAt": 1682408577978,
- "installedAt": 1682408577987,
- "ipAddress": "192.168.0.1",
- "pollStatus": {
- "lastRequestAt": 1682408577978,
- "nextExpectedRequestAt": 1682451777978,
- "overdue": false
}, - "securityToken": "949f1c3487125467464a960d750373c1",
- "requestAttributes": true,
- "targetType": 13,
- "targetTypeName": "defaultType",
- "autoConfirmActive": false,
- "_links": {
- "actions": {
}, - "metadata": {
},
}
}
], - "total": 0,
- "size": 0,
- "_links": {
- "property1": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}, - "property2": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}
}
}
Handles the POST request of target assignment. Already assigned target will be ignored.
targetTagId required | integer <int64> |
List of controller ids to be assigned
[- "controllerId1",
- "controllerId2"
]
{- "exceptionClass": "string",
- "errorCode": "string",
- "message": "string",
- "parameters": [
- "string"
]
}
Handles the POST request of target assignment. Already assigned target will be ignored.
targetTagId required | integer <int64> |
controllerId required | string |
[- {
- "controllerId": "Target1"
}
]
[- {
- "createdBy": "bumlux",
- "createdAt": 1682408577979,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408577988,
- "name": "137",
- "description": "My name is 137",
- "controllerId": "137",
- "updateStatus": "in_sync",
- "lastControllerRequestAt": 1682408577978,
- "installedAt": 1682408577987,
- "ipAddress": "192.168.0.1",
- "pollStatus": {
- "lastRequestAt": 1682408577978,
- "nextExpectedRequestAt": 1682451777978,
- "overdue": false
}, - "securityToken": "949f1c3487125467464a960d750373c1",
- "requestAttributes": true,
- "targetType": 13,
- "targetTypeName": "defaultType",
- "autoConfirmActive": false,
- "_links": {
- "actions": {
}, - "metadata": {
},
}
}
]
Handles the GET request of retrieving all target tags.
offset | string The paging offset (default is 0) |
limit | string The maximum number of entries in a page (default is 50) |
sort | string The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result. |
q | string Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields. |
{- "content": [
- {
- "createdBy": "bumlux",
- "createdAt": 1682408561990,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408561992,
- "name": "DsTag",
- "description": "My name is DsTag",
- "colour": "default",
- "_links": {
- "assignedDistributionSets": {
}
}, - "id": 6
}
], - "total": 0,
- "size": 0,
- "_links": {
- "property1": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}, - "property2": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}
}
}
Handles the POST request of creating new target tag. The request body must always be a list of target tags.
name | string The name of the entity |
description | string The description of the entity |
colour | string The colour of the entity |
[- {
- "name": "Example name",
- "description": "Example description",
- "colour": "rgb(0,255,0)"
}
]
[- {
- "createdBy": "bumlux",
- "createdAt": 1682408561990,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408561992,
- "name": "DsTag",
- "description": "My name is DsTag",
- "colour": "default",
- "_links": {
- "assignedDistributionSets": {
}
}, - "id": 6
}
]
Handles the POST request of toggle target assignment. The request body must always be a list of controller ids.
targetTagId required | integer <int64> |
controllerId required | string |
[- {
- "controllerId": "Target1"
}
]
{- "assignedTargets": [
- {
- "createdBy": "bumlux",
- "createdAt": 1682408577979,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408577988,
- "name": "137",
- "description": "My name is 137",
- "controllerId": "137",
- "updateStatus": "in_sync",
- "lastControllerRequestAt": 1682408577978,
- "installedAt": 1682408577987,
- "ipAddress": "192.168.0.1",
- "pollStatus": {
- "lastRequestAt": 1682408577978,
- "nextExpectedRequestAt": 1682451777978,
- "overdue": false
}, - "securityToken": "949f1c3487125467464a960d750373c1",
- "requestAttributes": true,
- "targetType": 13,
- "targetTypeName": "defaultType",
- "autoConfirmActive": false,
- "_links": {
- "actions": {
}, - "metadata": {
},
}
}
], - "unassignedTargets": [
- {
- "createdBy": "bumlux",
- "createdAt": 1682408577979,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408577988,
- "name": "137",
- "description": "My name is 137",
- "controllerId": "137",
- "updateStatus": "in_sync",
- "lastControllerRequestAt": 1682408577978,
- "installedAt": 1682408577987,
- "ipAddress": "192.168.0.1",
- "pollStatus": {
- "lastRequestAt": 1682408577978,
- "nextExpectedRequestAt": 1682451777978,
- "overdue": false
}, - "securityToken": "949f1c3487125467464a960d750373c1",
- "requestAttributes": true,
- "targetType": 13,
- "targetTypeName": "defaultType",
- "autoConfirmActive": false,
- "_links": {
- "actions": {
}, - "metadata": {
},
}
}
]
}
Handles the DELETE request to unassign the given target.
targetTagId required | integer <int64> |
controllerId required | string |
{- "exceptionClass": "string",
- "errorCode": "string",
- "message": "string",
- "parameters": [
- "string"
]
}
Handles the GET request of retrieving a single target filter query. Required permission: READ_TARGET
filterId required | integer <int64> |
{- "createdBy": "bumlux",
- "createdAt": 1682408566380,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408566385,
- "name": "filter1",
- "query": "name==*",
- "autoAssignDistributionSet": 3,
- "autoAssignActionType": "forced",
- "autoAssignWeight": null,
- "confirmationRequired": null,
- "_links": {
}, - "id": 5
}
Handles the PUT request of updating a target filter query. Required permission: UPDATE_TARGET
filterId required | integer <int64> |
name required | string |
query required | string |
{- "name": "filterName",
- "query": "controllerId==example-target-*"
}
{- "createdBy": "bumlux",
- "createdAt": 1682408566380,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408566385,
- "name": "filter1",
- "query": "name==*",
- "autoAssignDistributionSet": 3,
- "autoAssignActionType": "forced",
- "autoAssignWeight": null,
- "confirmationRequired": null,
- "_links": {
}, - "id": 5
}
Handles the DELETE request of deleting a target filter query. Required permission: DELETE_TARGET
filterId required | integer <int64> |
{- "exceptionClass": "string",
- "errorCode": "string",
- "message": "string",
- "parameters": [
- "string"
]
}
Handles the GET request of retrieving all target filter queries. Required permission: READ_TARGET
offset | string The paging offset (default is 0) |
limit | string The maximum number of entries in a page (default is 50) |
sort | string The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result. |
q | string Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields. |
representation | string Default: "compact" |
{- "content": [
- {
- "createdBy": "bumlux",
- "createdAt": 1682408566380,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408566385,
- "name": "filter1",
- "query": "name==*",
- "autoAssignDistributionSet": 3,
- "autoAssignActionType": "forced",
- "autoAssignWeight": null,
- "confirmationRequired": null,
- "_links": {
}, - "id": 5
}
], - "total": 0,
- "size": 0,
- "_links": {
- "property1": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}, - "property2": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}
}
}
Handles the POST request to create a new target filter query. Required permission: CREATE_TARGET
name required | string |
query required | string |
{- "name": "filterName",
- "query": "controllerId==example-target-*"
}
{- "createdBy": "bumlux",
- "createdAt": 1682408566380,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408566385,
- "name": "filter1",
- "query": "name==*",
- "autoAssignDistributionSet": 3,
- "autoAssignActionType": "forced",
- "autoAssignWeight": null,
- "confirmationRequired": null,
- "_links": {
}, - "id": 5
}
Handles the GET request of retrieving the auto assign distribution set. Required permission: READ_TARGET
filterId required | integer <int64> |
{- "createdBy": "bumlux",
- "createdAt": 1682408574924,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408574925,
- "name": "DS",
- "description": "Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1",
- "version": "1.0",
- "modules": [
- {
- "createdBy": "bumlux",
- "createdAt": 1682408574921,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408574926,
- "name": "Firmware",
- "description": "Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1",
- "version": "1.0.42",
- "type": "os",
- "typeName": "OS",
- "vendor": "vendor Limited Inc, California",
- "locked": true,
- "deleted": false,
- "encrypted": false,
- "id": 18
}, - {
- "createdBy": "bumlux",
- "createdAt": 1682408574920,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408574925,
- "name": "app runtime",
- "description": "Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1",
- "version": "1.0.25",
- "type": "runtime",
- "typeName": "runtime",
- "vendor": "vendor GmbH, Stuttgart, Germany",
- "locked": true,
- "deleted": false,
- "encrypted": false,
- "id": 17
}, - {
- "createdBy": "bumlux",
- "createdAt": 1682408574919,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408574926,
- "name": "application",
- "description": "Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1",
- "version": "1.0.67",
- "type": "application",
- "typeName": "Application",
- "vendor": "vendor Limited, California",
- "locked": true,
- "deleted": false,
- "encrypted": false,
- "id": 16
}
], - "requiredMigrationStep": false,
- "type": "test_default_ds_type",
- "typeName": "OS (FW) mandatory, runtime (FW) and app (SW) optional",
- "complete": true,
- "deleted": false,
- "valid": true,
- "_links": {
- "modules": {
}, - "metadata": {
}
}, - "id": 6
}
Handles the POST request of setting the auto assign distribution set for a target filter query. Required permissions: UPDATE_TARGET and READ_REPOSITORY
filterId required | integer <int64> |
id | integer <int64> |
type | string Enum: "soft" "forced" "timeforced" "downloadonly" |
weight | integer <int32> |
confirmationRequired | boolean |
{- "id": 108,
- "type": "soft",
- "weight": 0,
- "confirmationRequired": true
}
{- "createdBy": "bumlux",
- "createdAt": 1682408566380,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408566385,
- "name": "filter1",
- "query": "name==*",
- "autoAssignDistributionSet": 3,
- "autoAssignActionType": "forced",
- "autoAssignWeight": null,
- "confirmationRequired": null,
- "_links": {
}, - "id": 5
}
Removes the auto assign distribution set from the target filter query. Required permission: UPDATE_TARGET
filterId required | integer <int64> |
{- "exceptionClass": "string",
- "errorCode": "string",
- "message": "string",
- "parameters": [
- "string"
]
}
Handles the GET request of retrieving a single distribution set tag.
distributionsetTagId required | integer <int64> |
{- "createdBy": "bumlux",
- "createdAt": 1682408561990,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408561992,
- "name": "DsTag",
- "description": "My name is DsTag",
- "colour": "default",
- "_links": {
- "assignedDistributionSets": {
}
}, - "id": 6
}
Handles the PUT request of updating a distribution set tag.
distributionsetTagId required | integer <int64> |
name | string The name of the entity |
description | string The description of the entity |
colour | string The colour of the entity |
{- "name": "Example name",
- "description": "Example description",
- "colour": "rgb(0,255,0)"
}
{- "createdBy": "bumlux",
- "createdAt": 1682408561990,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408561992,
- "name": "DsTag",
- "description": "My name is DsTag",
- "colour": "default",
- "_links": {
- "assignedDistributionSets": {
}
}, - "id": 6
}
Handles the DELETE request of deleting a single distribution set tag.
distributionsetTagId required | integer <int64> |
{- "exceptionClass": "string",
- "errorCode": "string",
- "message": "string",
- "parameters": [
- "string"
]
}
Handles the GET request of retrieving all distribution set tags.
offset | string The paging offset (default is 0) |
limit | string The maximum number of entries in a page (default is 50) |
sort | string The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result. |
q | string Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields. |
{- "content": [
- {
- "createdBy": "bumlux",
- "createdAt": 1682408561990,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408561992,
- "name": "DsTag",
- "description": "My name is DsTag",
- "colour": "default",
- "_links": {
- "assignedDistributionSets": {
}
}, - "id": 6
}
], - "total": 0,
- "size": 0,
- "_links": {
- "property1": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}, - "property2": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}
}
}
Handles the POST request of creating new distribution set tag. The request body must always be a list of distribution set tags.
name | string The name of the entity |
description | string The description of the entity |
colour | string The colour of the entity |
[- {
- "name": "Example name",
- "description": "Example description",
- "colour": "rgb(0,255,0)"
}
]
[- {
- "createdBy": "bumlux",
- "createdAt": 1682408561990,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408561992,
- "name": "DsTag",
- "description": "My name is DsTag",
- "colour": "default",
- "_links": {
- "assignedDistributionSets": {
}
}, - "id": 6
}
]
Handles the GET request of retrieving a list of assigned distributions.
distributionsetTagId required | integer <int64> |
offset | string The paging offset (default is 0) |
limit | string The maximum number of entries in a page (default is 50) |
sort | string The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result. |
q | string Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields. |
{- "content": [
- {
- "createdBy": "bumlux",
- "createdAt": 1682408574924,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408574925,
- "name": "DS",
- "description": "Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1",
- "version": "1.0",
- "modules": [
- {
- "createdBy": "bumlux",
- "createdAt": 1682408574921,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408574926,
- "name": "Firmware",
- "description": "Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1",
- "version": "1.0.42",
- "type": "os",
- "typeName": "OS",
- "vendor": "vendor Limited Inc, California",
- "locked": true,
- "deleted": false,
- "encrypted": false,
- "id": 18
}, - {
- "createdBy": "bumlux",
- "createdAt": 1682408574920,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408574925,
- "name": "app runtime",
- "description": "Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1",
- "version": "1.0.25",
- "type": "runtime",
- "typeName": "runtime",
- "vendor": "vendor GmbH, Stuttgart, Germany",
- "locked": true,
- "deleted": false,
- "encrypted": false,
- "id": 17
}, - {
- "createdBy": "bumlux",
- "createdAt": 1682408574919,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408574926,
- "name": "application",
- "description": "Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1",
- "version": "1.0.67",
- "type": "application",
- "typeName": "Application",
- "vendor": "vendor Limited, California",
- "locked": true,
- "deleted": false,
- "encrypted": false,
- "id": 16
}
], - "requiredMigrationStep": false,
- "type": "test_default_ds_type",
- "typeName": "OS (FW) mandatory, runtime (FW) and app (SW) optional",
- "complete": true,
- "deleted": false,
- "valid": true,
- "_links": {
- "modules": {
}, - "metadata": {
}
}, - "id": 6
}
], - "total": 0,
- "size": 0,
- "_links": {
- "property1": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}, - "property2": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}
}
}
Handles the POST request of distribution assignment. Already assigned distribution will be ignored.
distributionsetTagId required | integer <int64> |
id required | integer <int64> |
[- {
- "id": 24
}
]
[- {
- "createdBy": "bumlux",
- "createdAt": 1682408574924,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408574925,
- "name": "DS",
- "description": "Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1",
- "version": "1.0",
- "modules": [
- {
- "createdBy": "bumlux",
- "createdAt": 1682408574921,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408574926,
- "name": "Firmware",
- "description": "Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1",
- "version": "1.0.42",
- "type": "os",
- "typeName": "OS",
- "vendor": "vendor Limited Inc, California",
- "locked": true,
- "deleted": false,
- "encrypted": false,
- "id": 18
}, - {
- "createdBy": "bumlux",
- "createdAt": 1682408574920,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408574925,
- "name": "app runtime",
- "description": "Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1",
- "version": "1.0.25",
- "type": "runtime",
- "typeName": "runtime",
- "vendor": "vendor GmbH, Stuttgart, Germany",
- "locked": true,
- "deleted": false,
- "encrypted": false,
- "id": 17
}, - {
- "createdBy": "bumlux",
- "createdAt": 1682408574919,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408574926,
- "name": "application",
- "description": "Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1",
- "version": "1.0.67",
- "type": "application",
- "typeName": "Application",
- "vendor": "vendor Limited, California",
- "locked": true,
- "deleted": false,
- "encrypted": false,
- "id": 16
}
], - "requiredMigrationStep": false,
- "type": "test_default_ds_type",
- "typeName": "OS (FW) mandatory, runtime (FW) and app (SW) optional",
- "complete": true,
- "deleted": false,
- "valid": true,
- "_links": {
- "modules": {
}, - "metadata": {
}
}, - "id": 6
}
]
Handles the POST request of toggle distribution assignment. The request body must always be a list of distribution set ids.
distributionsetTagId required | integer <int64> |
id required | integer <int64> |
[- {
- "id": 24
}
]
{- "exceptionClass": "string",
- "errorCode": "string",
- "message": "string",
- "parameters": [
- "string"
]
}
Handles the DELETE request of unassign the given distribution.
distributionsetTagId required | integer <int64> |
distributionsetId required | integer <int64> |
{- "exceptionClass": "string",
- "errorCode": "string",
- "message": "string",
- "parameters": [
- "string"
]
}
Handles the GET request of retrieving a single distribution set type. Required Permission: READ_REPOSITORY
distributionSetTypeId required | integer <int64> |
{- "createdBy": "bumlux",
- "createdAt": 1682408579418,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408579459,
- "name": "OS (FW) mandatory, runtime (FW) and app (SW) optional",
- "description": "Desc1234",
- "key": "test_default_ds_type",
- "deleted": false,
- "colour": "rgb(86,37,99)",
- "_links": {
- "mandatorymodules": {
}, - "optionalmodules": {
}
}, - "id": 14
}
Handles the PUT request for a single distribution set type. Required Permission: UPDATE_REPOSITORY
distributionSetTypeId required | integer <int64> |
description | string The description of the entity |
colour | string The colour of the entity |
{- "description": "Example description",
- "colour": "rgb(86,37,99)"
}
{- "createdBy": "bumlux",
- "createdAt": 1682408579418,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408579459,
- "name": "OS (FW) mandatory, runtime (FW) and app (SW) optional",
- "description": "Desc1234",
- "key": "test_default_ds_type",
- "deleted": false,
- "colour": "rgb(86,37,99)",
- "_links": {
- "mandatorymodules": {
}, - "optionalmodules": {
}
}, - "id": 14
}
Handles the DELETE request for a single distribution set type. Required Permission: DELETE_REPOSITORY
distributionSetTypeId required | integer <int64> |
{- "exceptionClass": "string",
- "errorCode": "string",
- "message": "string",
- "parameters": [
- "string"
]
}
Handles the GET request of retrieving all distribution set types. Required Permission: READ_REPOSITORY
offset | string The paging offset (default is 0) |
limit | string The maximum number of entries in a page (default is 50) |
sort | string The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result. |
q | string Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields. |
{- "content": [
- {
- "createdBy": "bumlux",
- "createdAt": 1682408579418,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408579459,
- "name": "OS (FW) mandatory, runtime (FW) and app (SW) optional",
- "description": "Desc1234",
- "key": "test_default_ds_type",
- "deleted": false,
- "colour": "rgb(86,37,99)",
- "_links": {
- "mandatorymodules": {
}, - "optionalmodules": {
}
}, - "id": 14
}
], - "total": 0,
- "size": 0,
- "_links": {
- "property1": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}, - "property2": {
- "href": "string",
- "hreflang": "string",
- "title": "string",
- "type": "string",
- "deprecation": "string",
- "profile": "string",
- "name": "string",
- "templated": true
}
}
}
Handles the POST request for creating new distribution set types. The request body must always be a list of types. Required Permission: CREATE_REPOSITORY
description | string The description of the entity |
colour | string The colour of the entity |
name required | string The name of the entity |
key required | string Functional key of the distribution set type |
Array of objects (MgmtSoftwareModuleTypeAssigment) Mandatory module type IDs | |
Array of objects (MgmtSoftwareModuleTypeAssigment) Optional module type IDs |
[- {
- "description": "Example description",
- "colour": "rgb(86,37,99)",
- "name": "Example type name",
- "key": "Example key",
- "mandatorymodules": [
- {
- "id": 108
}
], - "optionalmodules": [
- {
- "id": 108
}
]
}
]
[- {
- "createdBy": "bumlux",
- "createdAt": 1682408579418,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408579459,
- "name": "OS (FW) mandatory, runtime (FW) and app (SW) optional",
- "description": "Desc1234",
- "key": "test_default_ds_type",
- "deleted": false,
- "colour": "rgb(86,37,99)",
- "_links": {
- "mandatorymodules": {
}, - "optionalmodules": {
}
}, - "id": 14
}
]
Handles the GET request of retrieving the list of optional software module types in that distribution set type. Required Permission: READ_REPOSITORY
distributionSetTypeId required | integer <int64> |
[- {
- "createdBy": "system",
- "createdAt": 1682408579390,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408579394,
- "name": "Application",
- "description": "Updated description.",
- "key": "application",
- "maxAssignments": 2147483647,
- "deleted": false,
- "id": 4
}
]
Handles the POST request for adding an optional software module type to a distribution set type.Note that a DS type cannot be changed after it has been used by a DS. Required Permission: UPDATE_REPOSITORY and READ_REPOSITORY
distributionSetTypeId required | integer <int64> |
id | integer <int64> |
{- "id": 108
}
{- "exceptionClass": "string",
- "errorCode": "string",
- "message": "string",
- "parameters": [
- "string"
]
}
Handles the GET request of retrieving the list of mandatory software module types in that distribution set type. Required Permission: READ_REPOSITORY
distributionSetTypeId required | integer <int64> |
[- {
- "createdBy": "system",
- "createdAt": 1682408579390,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408579394,
- "name": "Application",
- "description": "Updated description.",
- "key": "application",
- "maxAssignments": 2147483647,
- "deleted": false,
- "id": 4
}
]
Handles the POST request for adding a mandatory software module type to a distribution set type.Note that a DS type cannot be changed after it has been used by a DS. Required Permission: UPDATE_REPOSITORY and READ_REPOSITORY
distributionSetTypeId required | integer <int64> |
id | integer <int64> |
{- "id": 108
}
{- "exceptionClass": "string",
- "errorCode": "string",
- "message": "string",
- "parameters": [
- "string"
]
}
Handles the GET request of retrieving the single optional software module type in that distribution set type. Required Permission: READ_REPOSITORY
distributionSetTypeId required | integer <int64> |
softwareModuleTypeId required | integer <int64> |
{- "createdBy": "system",
- "createdAt": 1682408579390,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408579394,
- "name": "Application",
- "description": "Updated description.",
- "key": "application",
- "maxAssignments": 2147483647,
- "deleted": false,
- "id": 4
}
Handles DELETE request for removing an optional module from the distribution set type. Note that a DS type cannot be changed after it has been used by a DS. Required Permission: UPDATE_REPOSITORY and READ_REPOSITORY
distributionSetTypeId required | integer <int64> |
softwareModuleTypeId required | integer <int64> |
{- "exceptionClass": "string",
- "errorCode": "string",
- "message": "string",
- "parameters": [
- "string"
]
}
Handles the GET request of retrieving the single mandatory software module type in that distribution set type. Required Permission: READ_REPOSITORY
distributionSetTypeId required | integer <int64> |
softwareModuleTypeId required | integer <int64> |
{- "createdBy": "system",
- "createdAt": 1682408579390,
- "lastModifiedBy": "bumlux",
- "lastModifiedAt": 1682408579394,
- "name": "Application",
- "description": "Updated description.",
- "key": "application",
- "maxAssignments": 2147483647,
- "deleted": false,
- "id": 4
}
Handles the DELETE request for removing a software module type from a single distribution set type. Required Permission: DELETE_REPOSITORY
distributionSetTypeId required | integer <int64> |
softwareModuleTypeId required | integer <int64> |
{- "exceptionClass": "string",
- "errorCode": "string",
- "message": "string",
- "parameters": [
- "string"
]
}
The GET request returns a list of all possible configuration keys for the tenant. Required Permission: READ_TENANT_CONFIGURATION
{- "property1": {
- "value": "",
- "global": true,
- "_links": {
}
}, - "property2": {
- "value": "",
- "global": true,
- "_links": {
}
}
}
The PUT request updates the whole configuration for the tenant. Required Permission: TENANT_CONFIGURATION
property name* additional property | object |
{- "property1": { },
- "property2": { }
}
[- {
- "value": "",
- "global": true,
- "_links": {
}
}
]
The GET request returns the configuration value of a specific configuration key for the tenant. Required Permission: READ_TENANT_CONFIGURATION
keyName required | string |
{- "value": "",
- "global": true,
- "_links": {
}
}
The PUT request changes a configuration value of a specific configuration key for the tenant. Required Permission: TENANT_CONFIGURATION
keyName required | string |
value required | object Current value of of configuration parameter |
{- "value": "exampleToken"
}
{- "value": "",
- "global": true,
- "_links": {
}
}
The DELETE request removes a tenant specific configuration value for the tenant. Afterwards the global default value is used. Required Permission: TENANT_CONFIGURATION
keyName required | string |
{- "exceptionClass": "string",
- "errorCode": "string",
- "message": "string",
- "parameters": [
- "string"
]
}