- GET /rest/v1/distributionsettypes
- POST /rest/v1/distributionsettypes
- DELETE /rest/v1/distributionsettypes/{distributionSetTypeId}
- GET /rest/v1/distributionsettypes/{distributionSetTypeId}
- PUT /rest/v1/distributionsettypes/{distributionSetTypeId}
- GET /rest/v1/distributionsettypes/{distributionSetTypeId}/mandatorymoduletypes
- POST /rest/v1/distributionsettypes/{distributionSetTypeId}/mandatorymoduletypes
- DELETE /rest/v1/distributionsettypes/{distributionSetTypeId}/mandatorymoduletypes/{softwareModuleTypeId}
- GET /rest/v1/distributionsettypes/{distributionSetTypeId}/mandatorymoduletypes/{softwareModuleTypeId}
- GET /rest/v1/distributionsettypes/{distributionSetTypeId}/optionalmoduletypes
- POST /rest/v1/distributionsettypes/{distributionSetTypeId}/optionalmoduletypes
- DELETE /rest/v1/distributionsettypes/{distributionSetTypeId}/optionalmoduletypes/{softwareModuleTypeId}
- DELETE /rest/v1/distributionsettypes/{distributionSetTypeId}/mandatorymoduletypes/{softwareModuleTypeId}
- GET /rest/v1/distributionsettypes/{distributionSetTypeId}/optionalmoduletypes/{softwareModuleTypeId}
- Additional content
GET /rest/v1/distributionsettypes
Implementation notes
Handles the GET request of retrieving all distribution set types withinfGET /rest/v1/distributionsettypes SP. 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 |
Response example
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 1756
{
"content" : [ {
"createdBy" : "system",
"createdAt" : 1567757266727,
"lastModifiedBy" : "system",
"lastModifiedAt" : 1567757266727,
"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/423"
}
},
"id" : 423
}, {
"createdBy" : "system",
"createdAt" : 1567757266728,
"lastModifiedBy" : "system",
"lastModifiedAt" : 1567757266728,
"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/424"
}
},
"id" : 424
}, {
"createdBy" : "system",
"createdAt" : 1567757266727,
"lastModifiedBy" : "system",
"lastModifiedAt" : 1567757266727,
"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/425"
}
},
"id" : 425
}, {
"createdBy" : "bumlux",
"createdAt" : 1567757266742,
"lastModifiedBy" : "bumlux",
"lastModifiedAt" : 1567757266776,
"name" : "OS (FW) mandatory, runtime (FW) and app (SW) optional",
"description" : "Desc1234",
"key" : "test_default_ds_type",
"deleted" : false,
"_links" : {
"self" : {
"href" : "https://management-api.host.com/rest/v1/distributionsettypes/426"
}
},
"id" : 426
} ],
"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 SP. 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 'Accept: application/json' \
-H 'Content-Type: application/json;charset=UTF-8' \
-d '[ {
"optionalmodules" : [ {
"id" : 309
} ],
"name" : "TestName1",
"description" : "Desc1",
"mandatorymodules" : [ {
"id" : 307
} ],
"key" : "test1"
} ]'
Request URL
POST /rest/v1/distributionsettypes HTTP/1.1
Content-Length: 173
Accept: application/json
Content-Type: application/json;charset=UTF-8
Host: management-api.host.com
[ {
"optionalmodules" : [ {
"id" : 309
} ],
"name" : "TestName1",
"description" : "Desc1",
"mandatorymodules" : [ {
"id" : 307
} ],
"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 |
||
[]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 |
Response example
HTTP/1.1 201 Created
Content-Length: 370
Content-Type: application/json;charset=UTF-8
[ {
"createdBy" : "uploadTester",
"createdAt" : 1567757266358,
"lastModifiedBy" : "uploadTester",
"lastModifiedAt" : 1567757266358,
"name" : "TestName1",
"description" : "Desc1",
"key" : "test1",
"deleted" : false,
"_links" : {
"self" : {
"href" : "https://management-api.host.com/rest/v1/distributionsettypes/413"
}
},
"id" : 413
} ]
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 SP. Required Permission: DELETE_REPOSITORY
Delete distribution set type
CURL
$ curl 'https://management-api.host.com/rest/v1/distributionsettypes/449' -i -X DELETE
Request URL
DELETE /rest/v1/distributionsettypes/449 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 SP. Required Permission: READ_REPOSITORY
Get distribution set type
CURL
$ curl 'https://management-api.host.com/rest/v1/distributionsettypes/422' -i -X GET \
-H 'Accept: application/json'
Request URL
GET /rest/v1/distributionsettypes/422 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 |
|
_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-Length: 688
Content-Type: application/json;charset=UTF-8
{
"createdBy" : "bumlux",
"createdAt" : 1567757266519,
"lastModifiedBy" : "bumlux",
"lastModifiedAt" : 1567757266695,
"name" : "OS (FW) mandatory, runtime (FW) and app (SW) optional",
"description" : "Desc1234",
"key" : "test_default_ds_type",
"deleted" : false,
"_links" : {
"self" : {
"href" : "https://management-api.host.com/rest/v1/distributionsettypes/422"
},
"mandatorymodules" : {
"href" : "https://management-api.host.com/rest/v1/distributionsettypes/422/mandatorymoduletypes"
},
"optionalmodules" : {
"href" : "https://management-api.host.com/rest/v1/distributionsettypes/422/optionalmoduletypes"
}
},
"id" : 422
}
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 SP. Required Permission: UPDATE_REPOSITORY
Update distribution set type
CURL
$ curl 'https://management-api.host.com/rest/v1/distributionsettypes/453' -i -X PUT \
-H 'Content-Type: application/json;charset=UTF-8' \
-d '{
"description" : "an updated desription"
}'
Request URL
PUT /rest/v1/distributionsettypes/453 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Content-Length: 45
Host: management-api.host.com
{
"description" : "an updated desription"
}
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 |
X |
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 |
|
_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;charset=UTF-8
Content-Length: 701
{
"createdBy" : "bumlux",
"createdAt" : 1567757267153,
"lastModifiedBy" : "bumlux",
"lastModifiedAt" : 1567757267189,
"name" : "OS (FW) mandatory, runtime (FW) and app (SW) optional",
"description" : "an updated desription",
"key" : "test_default_ds_type",
"deleted" : false,
"_links" : {
"self" : {
"href" : "https://management-api.host.com/rest/v1/distributionsettypes/453"
},
"mandatorymodules" : {
"href" : "https://management-api.host.com/rest/v1/distributionsettypes/453/mandatorymoduletypes"
},
"optionalmodules" : {
"href" : "https://management-api.host.com/rest/v1/distributionsettypes/453/optionalmoduletypes"
}
},
"id" : 453
}
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/440/mandatorymoduletypes' -i -X GET \
-H 'Accept: application/json'
Request URL
GET /rest/v1/distributionsettypes/440/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;charset=UTF-8
Content-Length: 386
[ {
"createdBy" : "system",
"createdAt" : 1567757266941,
"lastModifiedBy" : "bumlux",
"lastModifiedAt" : 1567757266952,
"name" : "OS",
"description" : "Updated description.",
"key" : "os",
"maxAssignments" : 1,
"deleted" : false,
"_links" : {
"self" : {
"href" : "https://management-api.host.com/rest/v1/softwaremoduletypes/326"
}
},
"id" : 326
} ]
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/435/mandatorymoduletypes' -i -X POST \
-H 'Content-Type: application/json;charset=UTF-8' \
-d '{
"id" : 323
}'
Request URL
POST /rest/v1/distributionsettypes/435/mandatorymoduletypes HTTP/1.1
Content-Length: 16
Content-Type: application/json;charset=UTF-8
Host: management-api.host.com
{
"id" : 323
}
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 SP. 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/467/mandatorymoduletypes/343' -i -X DELETE \
-H 'Content-Type: application/json;charset=UTF-8'
Request URL
DELETE /rest/v1/distributionsettypes/467/mandatorymoduletypes/343 HTTP/1.1
Content-Type: application/json;charset=UTF-8
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/458/mandatorymoduletypes/338' -i -X GET \
-H 'Content-Type: application/json;charset=UTF-8'
Request URL
GET /rest/v1/distributionsettypes/458/mandatorymoduletypes/338 HTTP/1.1
Content-Type: application/json;charset=UTF-8
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-Length: 382
Content-Type: application/hal+json;charset=UTF-8
{
"createdBy" : "system",
"createdAt" : 1567757267217,
"lastModifiedBy" : "bumlux",
"lastModifiedAt" : 1567757267223,
"name" : "OS",
"description" : "Updated description.",
"key" : "os",
"maxAssignments" : 1,
"deleted" : false,
"_links" : {
"self" : {
"href" : "https://management-api.host.com/rest/v1/softwaremoduletypes/338"
}
},
"id" : 338
}
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/445/optionalmoduletypes' -i -X GET \
-H 'Accept: application/json'
Request URL
GET /rest/v1/distributionsettypes/445/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 |
|
[]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-Length: 396
Content-Type: application/json;charset=UTF-8
[ {
"createdBy" : "bumlux",
"createdAt" : 1567757267018,
"lastModifiedBy" : "bumlux",
"lastModifiedAt" : 1567757267021,
"name" : "runtime",
"description" : "Updated description.",
"key" : "runtime",
"maxAssignments" : 1,
"deleted" : false,
"_links" : {
"self" : {
"href" : "https://management-api.host.com/rest/v1/softwaremoduletypes/330"
}
},
"id" : 330
} ]
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/472/optionalmoduletypes' -i -X POST \
-H 'Content-Type: application/json;charset=UTF-8' \
-d '{
"id" : 347
}'
Request URL
POST /rest/v1/distributionsettypes/472/optionalmoduletypes HTTP/1.1
Content-Length: 16
Content-Type: application/json;charset=UTF-8
Host: management-api.host.com
{
"id" : 347
}
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 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/477/optionalmoduletypes/350' -i -X DELETE \
-H 'Content-Type: application/json;charset=UTF-8'
Request URL
DELETE /rest/v1/distributionsettypes/477/optionalmoduletypes/350 HTTP/1.1
Content-Type: application/json;charset=UTF-8
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/418/optionalmoduletypes/311' -i -X GET \
-H 'Content-Type: application/json;charset=UTF-8'
Request URL
GET /rest/v1/distributionsettypes/418/optionalmoduletypes/311 HTTP/1.1
Content-Type: application/json;charset=UTF-8
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-Length: 409
Content-Type: application/hal+json;charset=UTF-8
{
"createdBy" : "system",
"createdAt" : 1567757266411,
"lastModifiedBy" : "bumlux",
"lastModifiedAt" : 1567757266425,
"name" : "Application",
"description" : "Updated description.",
"key" : "application",
"maxAssignments" : 2147483647,
"deleted" : false,
"_links" : {
"self" : {
"href" : "https://management-api.host.com/rest/v1/softwaremoduletypes/311"
}
},
"id" : 311
}
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 |