GET /rest/v1/distributionsettypes
Implementation notes
Handles the GET request of retrieving all distribution set types within Bosch IoT Rollouts. Required Permission: READ_REPOSITORY
Get distribution set types
CURL
$ curl 'https://management-api.host.com/rest/v1/distributionsettypes' -i -X GET \
-H 'Accept: application/json'
Request URL
GET /rest/v1/distributionsettypes HTTP/1.1
Accept: application/json
Host: management-api.host.com
Request query parameter
Parameter | Description |
---|---|
|
The maximum number of entries in a page (default is 50). |
|
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. |
|
The paging offset (default is 0). |
|
Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields. |
Request parameter example
GET /rest/v1/distributionsettypes?offset=1&limit=2&sort=name%3ADESC&q=name%3D%3Da* HTTP/1.1
Accept: application/json
Host: management-api.host.com
Response (Status 200)
Response fields
Path | Type | Description | Allowed Values |
---|---|---|---|
size |
Number |
Current page size |
|
total |
Number |
Total number of elements |
|
content |
Array |
List of provisioning targets. |
|
content[].createdBy |
String |
Entity was originally created by (User, AMQP-Controller, anonymous etc.) |
|
content[].createdAt |
Number |
Entity was originally created at (timestamp UTC in milliseconds) |
|
content[].description |
String |
The description of the entity |
|
content[].key |
String |
Functional key of the distribution set type. |
|
content[].id |
Number |
The technical identifier of the entity |
|
content[].lastModifiedAt |
Number |
Entity was last modified at (timestamp UTC in milliseconds) |
|
content[].lastModifiedBy |
String |
Entity was last modified by (User, AMQP-Controller, anonymous etc.) |
|
content[].name |
String |
The name of the entity |
|
content[].deleted |
Boolean |
Deleted flag, used for soft deleted entities |
Response example
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1778
{
"content" : [ {
"createdBy" : "system",
"createdAt" : 1691065914593,
"lastModifiedBy" : "system",
"lastModifiedAt" : 1691065914593,
"name" : "App(s) only",
"description" : "Default type with app(s) only.",
"key" : "app",
"deleted" : false,
"_links" : {
"self" : {
"href" : "https://management-api.host.com/rest/v1/distributionsettypes/99"
}
},
"id" : 99
}, {
"createdBy" : "system",
"createdAt" : 1691065914601,
"lastModifiedBy" : "system",
"lastModifiedAt" : 1691065914601,
"name" : "OS with app(s)",
"description" : "Default type with Firmware/OS and optional app(s).",
"key" : "os_app",
"deleted" : false,
"_links" : {
"self" : {
"href" : "https://management-api.host.com/rest/v1/distributionsettypes/100"
}
},
"id" : 100
}, {
"createdBy" : "system",
"createdAt" : 1691065914545,
"lastModifiedBy" : "system",
"lastModifiedAt" : 1691065914545,
"name" : "OS only",
"description" : "Default type with Firmware/OS only.",
"key" : "os",
"deleted" : false,
"_links" : {
"self" : {
"href" : "https://management-api.host.com/rest/v1/distributionsettypes/101"
}
},
"id" : 101
}, {
"createdBy" : "bumlux",
"createdAt" : 1691065915095,
"lastModifiedBy" : "bumlux",
"lastModifiedAt" : 1691065915684,
"name" : "OS (FW) mandatory, runtime (FW) and app (SW) optional",
"description" : "Desc1234",
"key" : "test_default_ds_type",
"deleted" : false,
"colour" : "black",
"_links" : {
"self" : {
"href" : "https://management-api.host.com/rest/v1/distributionsettypes/102"
}
},
"id" : 102
} ],
"total" : 4,
"size" : 4
}
Error responses
HTTP Status Code | Reason | Response Model |
---|---|---|
|
Bad Request - e.g. invalid parameters |
|
|
The request requires user authentication. |
|
|
Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies. |
See Error body |
|
The http request method is not allowed on the resource. |
|
|
In case accept header is specified and not application/json. |
|
|
Too many requests. The server will refuse further attempts and the client has to wait another second. |
POST /rest/v1/distributionsettypes
Implementation notes
Handles the POST request for creating new distribution set types within Bosch IoT Rollouts. The request body must always be a list of types. Required Permission: CREATE_REPOSITORY
Create distribution set types
CURL
$ curl 'https://management-api.host.com/rest/v1/distributionsettypes' -i -X POST \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '[ {
"colour" : "rgb(86,37,99)",
"optionalmodules" : [ {
"id" : 66
} ],
"name" : "TestName1",
"description" : "Desc1",
"mandatorymodules" : [ {
"id" : 64
} ],
"key" : "test1"
} ]'
Request URL
POST /rest/v1/distributionsettypes HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 201
Host: management-api.host.com
[ {
"colour" : "rgb(86,37,99)",
"optionalmodules" : [ {
"id" : 66
} ],
"name" : "TestName1",
"description" : "Desc1",
"mandatorymodules" : [ {
"id" : 64
} ],
"key" : "test1"
} ]
Request fields
Path | Type | Description | Allowed Values | Mandatory |
---|---|---|---|---|
[]key |
String |
Functional key of the distribution set type. |
X |
|
[]name |
String |
The name of the entity |
X |
|
[]description |
String |
The description of the entity |
||
[]colour |
String |
The colour of the entity |
||
[]mandatorymodules |
Array |
Mandatory module type IDs. |
||
[]optionalmodules |
Array |
Optional module type IDs. |
Response (Status 201)
Response fields
Path | Type | Description | Allowed Values |
---|---|---|---|
[]createdBy |
String |
Entity was originally created by (User, AMQP-Controller, anonymous etc.) |
|
[]createdAt |
Number |
Entity was originally created at (timestamp UTC in milliseconds) |
|
[]description |
String |
The description of the entity |
|
[]key |
String |
Functional key of the distribution set type. |
|
[]id |
Number |
The technical identifier of the entity |
|
[]lastModifiedAt |
Number |
Entity was last modified at (timestamp UTC in milliseconds) |
|
[]lastModifiedBy |
String |
Entity was last modified by (User, AMQP-Controller, anonymous etc.) |
|
[]name |
String |
The name of the entity |
|
[]deleted |
Boolean |
Deleted flag, used for soft deleted entities |
|
[]colour |
String |
The colour of the entity |
Response example
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 398
[ {
"createdBy" : "uploadTester",
"createdAt" : 1691065910882,
"lastModifiedBy" : "uploadTester",
"lastModifiedAt" : 1691065910882,
"name" : "TestName1",
"description" : "Desc1",
"key" : "test1",
"deleted" : false,
"colour" : "rgb(86,37,99)",
"_links" : {
"self" : {
"href" : "https://management-api.host.com/rest/v1/distributionsettypes/89"
}
},
"id" : 89
} ]
Error responses
HTTP Status Code | Reason | Response Model |
---|---|---|
|
Bad Request - e.g. invalid parameters |
|
|
The request requires user authentication. |
|
|
Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies. |
See Error body |
|
Distribution set type was not found. |
See Error body |
|
The http request method is not allowed on the resource. |
|
|
In case accept header is specified and not application/json. |
|
|
Distribution set type already exists |
See Error body |
|
The request was attempt with a media-type which is not supported by the server for this resource. |
|
|
Too many requests. The server will refuse further attempts and the client has to wait another second. |
DELETE /rest/v1/distributionsettypes/{distributionSetTypeId}
Implementation Notes
Handles the DELETE request for a single distribution set type within Bosch IoT Rollouts. Required Permission: DELETE_REPOSITORY
Delete distribution set type
CURL
$ curl 'https://management-api.host.com/rest/v1/distributionsettypes/125' -i -X DELETE
Request URL
DELETE /rest/v1/distributionsettypes/125 HTTP/1.1
Host: management-api.host.com
Request path parameter
Parameter | Description |
---|---|
distributionSetTypeId |
The technical identifier of the entity |
Response (Status 200)
Response example
HTTP/1.1 200 OK
Error responses
HTTP Status Code | Reason | Response Model |
---|---|---|
|
Bad Request - e.g. invalid parameters |
|
|
The request requires user authentication. |
|
|
Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies. |
See Error body |
|
Distribution set type was not found. |
See Error body |
|
The http request method is not allowed on the resource. |
|
|
In case accept header is specified and not application/json. |
|
|
Too many requests. The server will refuse further attempts and the client has to wait another second. |
GET /rest/v1/distributionsettypes/{distributionSetTypeId}
Implementation notes
Handles the GET request of retrieving a single distribution set type within Bosch IoT Rollouts. Required Permission: READ_REPOSITORY
Get distribution set type
CURL
$ curl 'https://management-api.host.com/rest/v1/distributionsettypes/98' -i -X GET \
-H 'Accept: application/json'
Request URL
GET /rest/v1/distributionsettypes/98 HTTP/1.1
Accept: application/json
Host: management-api.host.com
Request path parameter
Parameter | Description |
---|---|
distributionSetTypeId |
The technical identifier of the entity |
Response (Status 200)
Response fields
Path | Type | Description | Allowed Values |
---|---|---|---|
createdBy |
String |
Entity was originally created by (User, AMQP-Controller, anonymous etc.) |
|
createdAt |
Number |
Entity was originally created at (timestamp UTC in milliseconds) |
|
description |
String |
The description of the entity |
|
key |
String |
Functional key of the distribution set type. |
|
id |
Number |
The technical identifier of the entity |
|
lastModifiedAt |
Number |
Entity was last modified at (timestamp UTC in milliseconds) |
|
lastModifiedBy |
String |
Entity was last modified by (User, AMQP-Controller, anonymous etc.) |
|
name |
String |
The name of the entity |
|
deleted |
Boolean |
Deleted flag, used for soft deleted entities |
|
colour |
String |
The colour of the entity |
|
_links.mandatorymodules |
Object |
Link to mandatory software modules types in this distribution set type. |
|
_links.optionalmodules |
Object |
Link to optional software modules types in this distribution set type. |
Response example
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 714
{
"createdBy" : "bumlux",
"createdAt" : 1691065913012,
"lastModifiedBy" : "bumlux",
"lastModifiedAt" : 1691065914184,
"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" : {
"self" : {
"href" : "https://management-api.host.com/rest/v1/distributionsettypes/98"
},
"mandatorymodules" : {
"href" : "https://management-api.host.com/rest/v1/distributionsettypes/98/mandatorymoduletypes"
},
"optionalmodules" : {
"href" : "https://management-api.host.com/rest/v1/distributionsettypes/98/optionalmoduletypes"
}
},
"id" : 98
}
Error responses
HTTP Status Code | Reason | Response Model |
---|---|---|
|
Bad Request - e.g. invalid parameters |
|
|
The request requires user authentication. |
|
|
Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies. |
See Error body |
|
Distribution set type was not found. |
See Error body |
|
The http request method is not allowed on the resource. |
|
|
In case accept header is specified and not application/json. |
|
|
Too many requests. The server will refuse further attempts and the client has to wait another second. |
PUT /rest/v1/distributionsettypes/{distributionSetTypeId}
Implementation notes
Handles the PUT request for a single distribution set type within Bosch IoT Rollouts. Required Permission: UPDATE_REPOSITORY
Update distribution set type
CURL
$ curl 'https://management-api.host.com/rest/v1/distributionsettypes/129' -i -X PUT \
-H 'Content-Type: application/json' \
-d '{
"colour" : "rgb(106,178,83)",
"description" : "an updated description"
}'
Request URL
PUT /rest/v1/distributionsettypes/129 HTTP/1.1
Content-Type: application/json
Content-Length: 78
Host: management-api.host.com
{
"colour" : "rgb(106,178,83)",
"description" : "an updated description"
}
Request path parameter
Parameter | Description |
---|---|
distributionSetTypeId |
The technical identifier of the entity |
Request fields
Path | Type | Description | Allowed Values | Mandatory |
---|---|---|---|---|
description |
String |
The description of the entity |
||
colour |
String |
The colour of the entity |
Response (Status 200)
Response fields
Path | Type | Description | Allowed Values |
---|---|---|---|
createdBy |
String |
Entity was originally created by (User, AMQP-Controller, anonymous etc.) |
|
createdAt |
Number |
Entity was originally created at (timestamp UTC in milliseconds) |
|
description |
String |
The description of the entity |
|
key |
String |
Functional key of the distribution set type. |
|
id |
Number |
The technical identifier of the entity |
|
lastModifiedAt |
Number |
Entity was last modified at (timestamp UTC in milliseconds) |
|
lastModifiedBy |
String |
Entity was last modified by (User, AMQP-Controller, anonymous etc.) |
|
name |
String |
The name of the entity |
|
deleted |
Boolean |
Deleted flag, used for soft deleted entities |
|
colour |
String |
The colour of the entity |
|
_links.mandatorymodules |
Object |
Link to mandatory software modules types in this distribution set type. |
|
_links.optionalmodules |
Object |
Link to optional software modules types in this distribution set type. |
Response example
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 734
{
"createdBy" : "bumlux",
"createdAt" : 1691065922592,
"lastModifiedBy" : "bumlux",
"lastModifiedAt" : 1691065922989,
"name" : "OS (FW) mandatory, runtime (FW) and app (SW) optional",
"description" : "an updated description",
"key" : "test_default_ds_type",
"deleted" : false,
"colour" : "rgb(106,178,83)",
"_links" : {
"self" : {
"href" : "https://management-api.host.com/rest/v1/distributionsettypes/129"
},
"mandatorymodules" : {
"href" : "https://management-api.host.com/rest/v1/distributionsettypes/129/mandatorymoduletypes"
},
"optionalmodules" : {
"href" : "https://management-api.host.com/rest/v1/distributionsettypes/129/optionalmoduletypes"
}
},
"id" : 129
}
Error responses
HTTP Status Code | Reason | Response Model |
---|---|---|
|
Bad Request - e.g. invalid parameters |
|
|
The request requires user authentication. |
|
|
Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies. |
See Error body |
|
Distribution set type was not found. |
See Error body |
|
The http request method is not allowed on the resource. |
|
|
In case accept header is specified and not application/json. |
|
|
E.g. in case an entity is created or modified by another user in another request at the same time. You may retry your modification request. |
See Error body |
|
The request was attempt with a media-type which is not supported by the server for this resource. |
|
|
Too many requests. The server will refuse further attempts and the client has to wait another second. |
GET /rest/v1/distributionsettypes/{distributionSetTypeId}/mandatorymoduletypes
Implementation notes
Handles the GET request of retrieving the list of mandatory software module types in that distribution set type. Required Permission: READ_REPOSITORY
Lists all mandatory software module types
CURL
$ curl 'https://management-api.host.com/rest/v1/distributionsettypes/116/mandatorymoduletypes' -i -X GET \
-H 'Accept: application/json'
Request URL
GET /rest/v1/distributionsettypes/116/mandatorymoduletypes HTTP/1.1
Accept: application/json
Host: management-api.host.com
Request path parameter
Parameter | Description |
---|---|
distributionSetTypeId |
The technical identifier of the entity |
Response (Status 200)
Response fields
Path | Type | Description | Allowed Values |
---|---|---|---|
[]createdBy |
String |
Entity was originally created by (User, AMQP-Controller, anonymous etc.) |
|
[]createdAt |
Number |
Entity was originally created at (timestamp UTC in milliseconds) |
|
[]description |
String |
The description of the entity |
|
[]key |
String |
Key that can be interpreted by the target. |
|
[]maxAssignments |
Number |
Software modules of that type can be assigned at this maximum number (e.g. operating system only once). |
|
[]id |
Number |
The technical identifier of the entity |
|
[]lastModifiedAt |
Number |
Entity was last modified at (timestamp UTC in milliseconds) |
|
[]lastModifiedBy |
String |
Entity was last modified by (User, AMQP-Controller, anonymous etc.) |
|
[]name |
String |
The name of the entity |
|
[]deleted |
Boolean |
Deleted flag, used for soft deleted entities |
Response example
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 384
[ {
"createdBy" : "system",
"createdAt" : 1691065918835,
"lastModifiedBy" : "bumlux",
"lastModifiedAt" : 1691065919087,
"name" : "OS",
"description" : "Updated description.",
"key" : "os",
"maxAssignments" : 1,
"deleted" : false,
"_links" : {
"self" : {
"href" : "https://management-api.host.com/rest/v1/softwaremoduletypes/83"
}
},
"id" : 83
} ]
Error responses
HTTP Status Code | Reason | Response Model |
---|---|---|
|
Bad Request - e.g. invalid parameters |
|
|
The request requires user authentication. |
|
|
Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies. |
See Error body |
|
Distribution set type was not found. |
See Error body |
|
The http request method is not allowed on the resource. |
|
|
In case accept header is specified and not application/json. |
|
|
Too many requests. The server will refuse further attempts and the client has to wait another second. |
POST /rest/v1/distributionsettypes/{distributionSetTypeId}/mandatorymoduletypes
Implementation notes
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
Add mandatory software module type
CURL
$ curl 'https://management-api.host.com/rest/v1/distributionsettypes/111/mandatorymoduletypes' -i -X POST \
-H 'Content-Type: application/json' \
-d '{
"id" : 79
}'
Request URL
POST /rest/v1/distributionsettypes/111/mandatorymoduletypes HTTP/1.1
Content-Type: application/json
Content-Length: 15
Host: management-api.host.com
{
"id" : 79
}
Request path parameter
Parameter | Description |
---|---|
distributionSetTypeId |
The technical identifier of the entity |
Request fields
Path | Type | Description | Allowed Values | Mandatory |
---|---|---|---|---|
id |
Number |
The technical identifier of the entity |
X |
Response (Status 201)
Response example
HTTP/1.1 200 OK
Error responses
HTTP Status Code | Reason | Response Model |
---|---|---|
|
Bad Request - e.g. invalid parameters |
|
|
The request requires user authentication. |
|
|
Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies. |
See Error body |
|
Distribution set type was not found. |
See Error body |
|
The http request method is not allowed on the resource. |
|
|
In case accept header is specified and not application/json. |
|
|
Distribution set type already exists |
See Error body |
|
The request was attempt with a media-type which is not supported by the server for this resource. |
|
|
Too many requests. The server will refuse further attempts and the client has to wait another second. |
DELETE /rest/v1/distributionsettypes/{distributionSetTypeId}/mandatorymoduletypes/{softwareModuleTypeId}
Implementation Notes
Handles the DELETE request for removing a software module type from a single distribution set type within Bosch IoT Rollouts. Required Permission: DELETE_REPOSITORY
Delete mandatory software module type.
Remove mandatory module from distribution set type
CURL
$ curl 'https://management-api.host.com/rest/v1/distributionsettypes/143/mandatorymoduletypes/100' -i -X DELETE \
-H 'Content-Type: application/json'
Request URL
DELETE /rest/v1/distributionsettypes/143/mandatorymoduletypes/100 HTTP/1.1
Content-Type: application/json
Host: management-api.host.com
Request path parameter
Parameter | Description |
---|---|
distributionSetTypeId |
The technical identifier of the entity |
softwareModuleTypeId |
The technical identifier of the entity |
Response (Status 200)
Response example
HTTP/1.1 200 OK
Error responses
HTTP Status Code | Reason | Response Model |
---|---|---|
|
Bad Request - e.g. invalid parameters |
|
|
The request requires user authentication. |
|
|
Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies. |
See Error body |
|
Distribution set type was not found. |
See Error body |
|
The http request method is not allowed on the resource. |
|
|
In case accept header is specified and not application/json. |
|
|
Too many requests. The server will refuse further attempts and the client has to wait another second. |
GET /rest/v1/distributionsettypes/{distributionSetTypeId}/mandatorymoduletypes/{softwareModuleTypeId}
Implementation notes
Handles the GET request of retrieving the single mandatory software module type in that distribution set type. Required Permission: READ_REPOSITORY
Retrieve mandatory software module type
CURL
$ curl 'https://management-api.host.com/rest/v1/distributionsettypes/134/mandatorymoduletypes/95' -i -X GET \
-H 'Content-Type: application/json'
Request URL
GET /rest/v1/distributionsettypes/134/mandatorymoduletypes/95 HTTP/1.1
Content-Type: application/json
Host: management-api.host.com
Request path parameter
Parameter | Description |
---|---|
distributionSetTypeId |
The technical identifier of the entity |
softwareModuleTypeId |
The technical identifier of the entity |
Response (Status 200)
Response fields
Path | Type | Description | Allowed Values |
---|---|---|---|
createdBy |
String |
Entity was originally created by (User, AMQP-Controller, anonymous etc.) |
|
createdAt |
Number |
Entity was originally created at (timestamp UTC in milliseconds) |
|
description |
String |
The description of the entity |
|
key |
String |
Key that can be interpreted by the target. |
|
maxAssignments |
Number |
Software modules of that type can be assigned at this maximum number (e.g. operating system only once). |
|
id |
Number |
The technical identifier of the entity |
|
lastModifiedAt |
Number |
Entity was last modified at (timestamp UTC in milliseconds) |
|
lastModifiedBy |
String |
Entity was last modified by (User, AMQP-Controller, anonymous etc.) |
|
name |
String |
The name of the entity |
|
deleted |
Boolean |
Deleted flag, used for soft deleted entities |
Response example
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 380
{
"createdBy" : "system",
"createdAt" : 1691065923155,
"lastModifiedBy" : "bumlux",
"lastModifiedAt" : 1691065923223,
"name" : "OS",
"description" : "Updated description.",
"key" : "os",
"maxAssignments" : 1,
"deleted" : false,
"_links" : {
"self" : {
"href" : "https://management-api.host.com/rest/v1/softwaremoduletypes/95"
}
},
"id" : 95
}
Error responses
HTTP Status Code | Reason | Response Model |
---|---|---|
|
Bad Request - e.g. invalid parameters |
|
|
The request requires user authentication. |
|
|
Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies. |
See Error body |
|
Distribution set type was not found. |
See Error body |
|
The http request method is not allowed on the resource. |
|
|
In case accept header is specified and not application/json. |
|
|
Too many requests. The server will refuse further attempts and the client has to wait another second. |
GET /rest/v1/distributionsettypes/{distributionSetTypeId}/optionalmoduletypes
Implementation notes
Handles the GET request of retrieving the list of optional software module types in that distribution set type. Required Permission: READ_REPOSITORY
Lists all optional software module types
CURL
$ curl 'https://management-api.host.com/rest/v1/distributionsettypes/121/optionalmoduletypes' -i -X GET \
-H 'Accept: application/json'
Request URL
GET /rest/v1/distributionsettypes/121/optionalmoduletypes HTTP/1.1
Accept: application/json
Host: management-api.host.com
Request path parameter
Parameter | Description |
---|---|
distributionSetTypeId |
The technical identifier of the entity |
Response (Status 200)
Response fields
Path | Type | Description | Allowed Values |
---|---|---|---|
[]createdBy |
String |
Entity was originally created by (User, AMQP-Controller, anonymous etc.) |
|
[]createdAt |
Number |
Entity was originally created at (timestamp UTC in milliseconds) |
|
[]description |
String |
The description of the entity |
|
[]colour |
String |
The colour of the entity |
|
[]key |
String |
Key that can be interpreted by the target. |
|
[]maxAssignments |
Number |
Software modules of that type can be assigned at this maximum number (e.g. operating system only once). |
|
[]id |
Number |
The technical identifier of the entity |
|
[]lastModifiedAt |
Number |
Entity was last modified at (timestamp UTC in milliseconds) |
|
[]lastModifiedBy |
String |
Entity was last modified by (User, AMQP-Controller, anonymous etc.) |
|
[]name |
String |
The name of the entity |
|
[]deleted |
Boolean |
Deleted flag, used for soft deleted entities |
Response example
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 418
[ {
"createdBy" : "bumlux",
"createdAt" : 1691065920322,
"lastModifiedBy" : "bumlux",
"lastModifiedAt" : 1691065920398,
"name" : "runtime",
"description" : "Updated description.",
"key" : "runtime",
"maxAssignments" : 1,
"deleted" : false,
"colour" : "#ffffff",
"_links" : {
"self" : {
"href" : "https://management-api.host.com/rest/v1/softwaremoduletypes/87"
}
},
"id" : 87
} ]
Error responses
HTTP Status Code | Reason | Response Model |
---|---|---|
|
Bad Request - e.g. invalid parameters |
|
|
The request requires user authentication. |
|
|
Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies. |
See Error body |
|
Distribution set type was not found. |
See Error body |
|
The http request method is not allowed on the resource. |
|
|
In case accept header is specified and not application/json. |
|
|
Too many requests. The server will refuse further attempts and the client has to wait another second. |
POST /rest/v1/distributionsettypes/{distributionSetTypeId}/optionalmoduletypes
Implementation notes
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
Add optional software module type
CURL
$ curl 'https://management-api.host.com/rest/v1/distributionsettypes/148/optionalmoduletypes' -i -X POST \
-H 'Content-Type: application/json' \
-d '{
"id" : 103
}'
Request URL
POST /rest/v1/distributionsettypes/148/optionalmoduletypes HTTP/1.1
Content-Type: application/json
Content-Length: 16
Host: management-api.host.com
{
"id" : 103
}
Request path parameter
Parameter | Description |
---|---|
distributionSetTypeId |
The technical identifier of the entity |
Request fields
Path | Type | Description | Allowed Values | Mandatory |
---|---|---|---|---|
id |
Number |
The technical identifier of the entity |
X |
Response (Status 201)
Response example
HTTP/1.1 200 OK
Error responses
HTTP Status Code | Reason | Response Model |
---|---|---|
|
Bad Request - e.g. invalid parameters |
|
|
The request requires user authentication. |
|
|
Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies. |
See Error body |
|
Distribution set type was not found. |
See Error body |
|
The http request method is not allowed on the resource. |
|
|
In case accept header is specified and not application/json. |
|
|
Distribution set type already exists |
See Error body |
|
The request was attempt with a media-type which is not supported by the server for this resource. |
|
|
Too many requests. The server will refuse further attempts and the client has to wait another second. |
DELETE /rest/v1/distributionsettypes/{distributionSetTypeId}/optionalmoduletypes/{softwareModuleTypeId}
Implementation Notes
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
Remove optional module from distribution set type
CURL
$ curl 'https://management-api.host.com/rest/v1/distributionsettypes/153/optionalmoduletypes/107' -i -X DELETE \
-H 'Content-Type: application/json'
Request URL
DELETE /rest/v1/distributionsettypes/153/optionalmoduletypes/107 HTTP/1.1
Content-Type: application/json
Host: management-api.host.com
Request path parameter
Parameter | Description |
---|---|
distributionSetTypeId |
The technical identifier of the entity |
softwareModuleTypeId |
The technical identifier of the entity |
Response (Status 200)
Response example
HTTP/1.1 200 OK
Error responses
HTTP Status Code | Reason | Response Model |
---|---|---|
|
Bad Request - e.g. invalid parameters |
|
|
The request requires user authentication. |
|
|
Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies. |
See Error body |
|
Distribution set type was not found. |
See Error body |
|
The http request method is not allowed on the resource. |
|
|
In case accept header is specified and not application/json. |
|
|
Too many requests. The server will refuse further attempts and the client has to wait another second. |
GET /rest/v1/distributionsettypes/{distributionSetTypeId}/optionalmoduletypes/{softwareModuleTypeId}
Implementation notes
Handles the GET request of retrieving the single optional software module type in that distribution set type. Required Permission: READ_REPOSITORY
Retrieve optional software module type
CURL
$ curl 'https://management-api.host.com/rest/v1/distributionsettypes/94/optionalmoduletypes/68' -i -X GET \
-H 'Content-Type: application/json'
Request URL
GET /rest/v1/distributionsettypes/94/optionalmoduletypes/68 HTTP/1.1
Content-Type: application/json
Host: management-api.host.com
Request path parameter
Parameter | Description |
---|---|
distributionSetTypeId |
The technical identifier of the entity |
Response (Status 200)
Response fields
Path | Type | Description | Allowed Values |
---|---|---|---|
createdBy |
String |
Entity was originally created by (User, AMQP-Controller, anonymous etc.) |
|
createdAt |
Number |
Entity was originally created at (timestamp UTC in milliseconds) |
|
description |
String |
The description of the entity |
|
key |
String |
Key that can be interpreted by the target. |
|
maxAssignments |
Number |
Software modules of that type can be assigned at this maximum number (e.g. operating system only once). |
|
id |
Number |
The technical identifier of the entity |
|
lastModifiedAt |
Number |
Entity was last modified at (timestamp UTC in milliseconds) |
|
lastModifiedBy |
String |
Entity was last modified by (User, AMQP-Controller, anonymous etc.) |
|
name |
String |
The name of the entity |
|
deleted |
Boolean |
Deleted flag, used for soft deleted entities |
Response example
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 407
{
"createdBy" : "system",
"createdAt" : 1691065911405,
"lastModifiedBy" : "bumlux",
"lastModifiedAt" : 1691065911685,
"name" : "Application",
"description" : "Updated description.",
"key" : "application",
"maxAssignments" : 2147483647,
"deleted" : false,
"_links" : {
"self" : {
"href" : "https://management-api.host.com/rest/v1/softwaremoduletypes/68"
}
},
"id" : 68
}
Error responses
HTTP Status Code | Reason | Response Model |
---|---|---|
|
Bad Request - e.g. invalid parameters |
|
|
The request requires user authentication. |
|
|
Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies. |
See Error body |
|
Distribution set type was not found. |
See Error body |
|
The http request method is not allowed on the resource. |
|
|
In case accept header is specified and not application/json. |
|
|
Too many requests. The server will refuse further attempts and the client has to wait another second. |
Additional content
Error body
{
"errorCode": "string",
"exceptionClass": "string",
"message": "string",
"parameters": [
"string"
]
}
Field description
Field |
Description |
errorCode |
A error code/key set by server |
exceptionClass |
The involved exceptionClass |
message |
An error message set by the server |
parameters |
A list of parameters |