- GET /rest/v1/distributionsettags
- GET /rest/v1/distributionsettags/{distributionsetTagId}
- POST /rest/v1/distributionsettags
- PUT /rest/v1/distributionsettags/{distributionsetTagId}
- DELETE /rest/v1/distributionsettags/{distributionsetTagId}
- GET /rest/v1/distributionsettags/{distributionsetTagId}/distributionsets
- POST /rest/v1/distributionsettags/{distributionsetTagId}/distributionsets/toggleTagAssignment
- POST /rest/v1/distributionsettags/{distributionsetTagId}/distributionsets
- DELETE /rest/v1/distributionsettags/{distributionsetTagId}/distributionsets/{distributionsetId}
- Additional content
GET /rest/v1/distributionsettags
Implementation notes
Handles the GET request of retrieving all distribution set tags.
Get paged list of distribution set tags
CURL
$ curl 'https://management-api.host.com/rest/v1/distributionsettags' -i -X GET
Request URL
A GET
request is used to access the distribution set tags
GET /rest/v1/distributionsettags HTTP/1.1
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/distributionsettags?limit=10&sort=name:ASC&offset=0&q=name%3D%3DDsTag HTTP/1.1
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[].id |
Number |
The technical identifier of the entity |
|
content[].name |
String |
The name of the entity |
|
content[].description |
String |
The description of the entity |
|
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[].lastModifiedBy |
String |
Entity was last modified by User, AMQP-Controller, anonymous etc.) |
|
content[].lastModifiedAt |
Number |
Entity was last modified at (timestamp UTC in milliseconds) |
|
content[].colour |
String |
The colour of the entity |
Response example
HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 419
{
"content" : [ {
"createdBy" : "bumlux",
"createdAt" : 1564643976509,
"lastModifiedBy" : "bumlux",
"lastModifiedAt" : 1564643976518,
"name" : "DsTag",
"description" : "My name is DsTag",
"colour" : "default",
"_links" : {
"self" : {
"href" : "https://management-api.host.com/rest/v1/distributionsettags/2"
}
},
"id" : 2
} ],
"total" : 1,
"size" : 1
}
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. |
GET /rest/v1/distributionsettags/{distributionsetTagId}
Implementation notes
Handles the GET request of retrieving a single distribution set tag.
Get a single distribution set tag
CURL
$ curl 'https://management-api.host.com/rest/v1/distributionsettags/6' -i -X GET
Request URL
A GET
request is used to access the distribution set tag
GET /rest/v1/distributionsettags/6 HTTP/1.1
Host: management-api.host.com
Request path parameter
Parameter | Description |
---|---|
distributionsetTagId |
The technical identifier of the entity |
Response (Status 200)
Response fields
Path | Type | Description | Allowed Values |
---|---|---|---|
id |
Number |
The technical identifier of the entity |
|
name |
String |
The name of the entity |
|
description |
String |
The description of the entity |
|
createdBy |
String |
Entity was originally created by User, AMQP-Controller, anonymous etc.) |
|
createdAt |
Number |
Entity was originally created at (timestamp UTC in milliseconds) |
|
lastModifiedBy |
String |
Entity was last modified by User, AMQP-Controller, anonymous etc.) |
|
lastModifiedAt |
Number |
Entity was last modified at (timestamp UTC in milliseconds) |
|
colour |
String |
The colour of the entity |
|
_links.assignedDistributionSets |
Object |
Links to assigned distribution sets. |
Response example
HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 523
{
"createdBy" : "bumlux",
"createdAt" : 1564643998014,
"lastModifiedBy" : "bumlux",
"lastModifiedAt" : 1564643998019,
"name" : "DsTag",
"description" : "My name is DsTag",
"colour" : "default",
"_links" : {
"self" : {
"href" : "https://management-api.host.com/rest/v1/distributionsettags/6"
},
"assignedDistributionSets" : {
"href" : "https://management-api.host.com/rest/v1/distributionsettags/6/assigned?offset=0&limit=50{&sort,q}",
"templated" : true
}
},
"id" : 6
}
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/distributionsettags
Implementation Notes
Handles the POST request of creating new distribution set tag. The request body must always be a list of distribution set tags.
Create list of distribution set tags
CURL
$ curl 'https://management-api.host.com/rest/v1/distributionsettags' -i -X POST \
-H 'Content-Type: application/json;charset=UTF-8' \
-d '[ {
"colour" : "red",
"name" : "ds tag",
"description" : "ds tag description"
} ]'
Request URL
POST /rest/v1/distributionsettags HTTP/1.1
Content-Length: 87
Content-Type: application/json;charset=UTF-8
Host: management-api.host.com
[ {
"colour" : "red",
"name" : "ds tag",
"description" : "ds tag description"
} ]
Request fields
Path | Type | Description | Allowed Values | Mandatory |
---|---|---|---|---|
[]name |
String |
The name of the entity |
X |
|
[]description |
String |
The description of the entity |
X |
|
[]colour |
String |
The colour of the entity |
Response (Status 201)
Response fields
Path | Type | Description | Allowed Values |
---|---|---|---|
[]id |
Number |
The technical identifier of the entity |
|
[]name |
String |
The name of the entity |
|
[]description |
String |
The description of the entity |
|
[]createdBy |
String |
Entity was originally created by User, AMQP-Controller, anonymous etc.) |
|
[]createdAt |
Number |
Entity was originally created at (timestamp UTC in milliseconds) |
|
[]lastModifiedBy |
String |
Entity was last modified by User, AMQP-Controller, anonymous etc.) |
|
[]lastModifiedAt |
Number |
Entity was last modified at (timestamp UTC in milliseconds) |
|
[]colour |
String |
The colour of the entity |
Response example
HTTP/1.1 201 Created
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 343
[ {
"createdBy" : "bumlux",
"createdAt" : 1564644003288,
"lastModifiedBy" : "bumlux",
"lastModifiedAt" : 1564644003288,
"name" : "ds tag",
"description" : "ds tag description",
"colour" : "red",
"_links" : {
"self" : {
"href" : "https://management-api.host.com/rest/v1/distributionsettags/7"
}
},
"id" : 7
} ]
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. |
|
|
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. |
PUT /rest/v1/distributionsettags/{distributionsetTagId}
Implementation Notes
Handles the PUT request of updating a distribution set tag.
Update a distribution set tag
Curl
$ curl 'https://management-api.host.com/rest/v1/distributionsettags/1' -i -X PUT \
-H 'Content-Type: application/json;charset=UTF-8' \
-d '{
"colour" : "red",
"name" : "ds tag",
"description" : "ds tag description"
}'
Request URL
PUT /rest/v1/distributionsettags/1 HTTP/1.1
Content-Length: 83
Content-Type: application/json;charset=UTF-8
Host: management-api.host.com
{
"colour" : "red",
"name" : "ds tag",
"description" : "ds tag description"
}
Request path parameter
Parameter | Description |
---|---|
distributionsetTagId |
The technical identifier of the entity |
Request fields
Path | Type | Description | Allowed Values | Mandatory |
---|---|---|---|---|
name |
String |
The name of the entity |
X |
|
description |
String |
The description of the entity |
X |
|
colour |
String |
The colour of the entity |
Response (Status 200)
Response fields
Path | Type | Description | Allowed Values |
---|---|---|---|
id |
Number |
The technical identifier of the entity |
|
name |
String |
The name of the entity |
|
description |
String |
The description of the entity |
|
createdBy |
String |
Entity was originally created by User, AMQP-Controller, anonymous etc.) |
|
createdAt |
Number |
Entity was originally created at (timestamp UTC in milliseconds) |
|
lastModifiedBy |
String |
Entity was last modified by User, AMQP-Controller, anonymous etc.) |
|
lastModifiedAt |
Number |
Entity was last modified at (timestamp UTC in milliseconds) |
|
colour |
String |
The colour of the entity |
|
_links.assignedDistributionSets |
Object |
Links to assigned distribution sets. |
Response example
HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 522
{
"createdBy" : "bumlux",
"createdAt" : 1564643970689,
"lastModifiedBy" : "bumlux",
"lastModifiedAt" : 1564643970882,
"name" : "ds tag",
"description" : "ds tag description",
"colour" : "red",
"_links" : {
"self" : {
"href" : "https://management-api.host.com/rest/v1/distributionsettags/1"
},
"assignedDistributionSets" : {
"href" : "https://management-api.host.com/rest/v1/distributionsettags/1/assigned?offset=0&limit=50{&sort,q}",
"templated" : true
}
},
"id" : 1
}
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 |
|
Not Found Target. |
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. |
DELETE /rest/v1/distributionsettags/{distributionsetTagId}
Implementation Notes
Handles the DELETE request of deleting a single distribution set tag.
Deleting a distribution set tag
CURL
$ curl 'https://management-api.host.com/rest/v1/distributionsettags/4' -i -X DELETE \
-H 'Content-Type: application/json;charset=UTF-8'
Request URL
DELETE /rest/v1/distributionsettags/4 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: management-api.host.com
Request path parameter
Parameter | Description |
---|---|
distributionsetTagId |
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 |
|
Not Found Target. |
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/distributionsettags/{distributionsetTagId}/distributionsets
Implementation Notes
Handles the GET request of retrieving a list of assigned distributions.
Get a list of assigned distributions
CURL
$ curl 'https://management-api.host.com/rest/v1/distributionsettags/3/assigned' -i -X GET \
-H 'Content-Type: application/json;charset=UTF-8'
Request URL
GET /rest/v1/distributionsettags/3/assigned HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: management-api.host.com
Request path parameter
Parameter | Description |
---|---|
distributionsetTagId |
The technical identifier of the entity |
Response (Status 200)
Response fields
Path | Type | Description | Allowed Values |
---|---|---|---|
content[].id |
Number |
The technical identifier of the entity |
|
content[].name |
String |
The name of the entity |
|
content[].description |
String |
The description of the entity |
|
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[].lastModifiedBy |
String |
Entity was last modified by User, AMQP-Controller, anonymous etc.) |
|
content[].lastModifiedAt |
Number |
Entity was last modified at (timestamp UTC in milliseconds) |
|
content[].type |
String |
The type of the distribution set. |
|
content[].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) |
|
content[].complete |
Boolean |
True of the distribution set software module setup is complete as defined by the distribution set type. |
|
content[].deleted |
Boolean |
Deleted flag, used for soft deleted entities |
|
content[].version |
String |
Package version. |
|
size |
Number |
Current page size |
|
total |
Number |
Total number of elements |
|
content |
Array |
List of provisioning targets. |
Response example
HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 2125
{
"content" : [ {
"createdBy" : "bumlux",
"createdAt" : 1564643981803,
"lastModifiedBy" : "bumlux",
"lastModifiedAt" : 1564643981973,
"name" : "DS",
"description" : "The descption of the distribution set.",
"version" : "1.0",
"modules" : [ {
"createdBy" : "bumlux",
"createdAt" : 1564643981754,
"lastModifiedBy" : "bumlux",
"lastModifiedAt" : 1564643981894,
"name" : "app runtime",
"description" : "Description of the software module",
"version" : "1.0.21",
"type" : "runtime",
"vendor" : "vendor GmbH, Stuttgart, Germany",
"deleted" : false,
"_links" : {
"self" : {
"href" : "https://management-api.host.com/rest/v1/softwaremodules/8"
}
},
"id" : 8
}, {
"createdBy" : "bumlux",
"createdAt" : 1564643981740,
"lastModifiedBy" : "bumlux",
"lastModifiedAt" : 1564643981923,
"name" : "application",
"description" : "Description of the software module",
"version" : "1.0.89",
"type" : "application",
"vendor" : "vendor Limited, California",
"deleted" : false,
"_links" : {
"self" : {
"href" : "https://management-api.host.com/rest/v1/softwaremodules/7"
}
},
"id" : 7
}, {
"createdBy" : "bumlux",
"createdAt" : 1564643981767,
"lastModifiedBy" : "bumlux",
"lastModifiedAt" : 1564643981859,
"name" : "Firmware",
"description" : "Description of the software module",
"version" : "1.0.44",
"type" : "os",
"vendor" : "vendor Limited Inc, California",
"deleted" : false,
"_links" : {
"self" : {
"href" : "https://management-api.host.com/rest/v1/softwaremodules/9"
}
},
"id" : 9
} ],
"requiredMigrationStep" : false,
"type" : "test_default_ds_type",
"complete" : true,
"deleted" : false,
"_links" : {
"self" : {
"href" : "https://management-api.host.com/rest/v1/distributionsets/3"
}
},
"id" : 3
} ],
"total" : 1,
"size" : 1
}
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 |
|
Not Found Target. |
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/distributionsettags/{distributionsetTagId}/distributionsets/toggleTagAssignment
Implementation Notes
Handles the POST request of toogle distribution assignment. The request body must always be a list of controller ids.
Toogle distribution assignment
CURL
$ curl 'https://management-api.host.com/rest/v1/distributionsettags/9/assigned/toggleTagAssignment' -i -X POST \
-H 'Content-Type: application/json;charset=UTF-8' \
-d '[ {
"id" : 9
} ]'
Request URL
POST /rest/v1/distributionsettags/9/assigned/toggleTagAssignment HTTP/1.1
Content-Length: 18
Content-Type: application/json;charset=UTF-8
Host: management-api.host.com
[ {
"id" : 9
} ]
Request fields
Path | Type | Description | Allowed Values | Mandatory |
---|---|---|---|---|
[]id |
Number |
The technical identifier of the entity |
X |
Response (Status 200)
Response fields
Path | Type | Description | Allowed Values |
---|---|---|---|
assignedDistributionSets |
Array[Object] |
Assigned distribution sets. |
|
unassignedDistributionSets |
Array[Object] |
Unassigned distribution sets. |
Response example
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 2645
{
"assignedDistributionSets" : [ {
"createdBy" : "bumlux",
"createdAt" : 1564644013706,
"lastModifiedBy" : "bumlux",
"lastModifiedAt" : 1564644013842,
"name" : "DS",
"description" : "The descption of the distribution set.",
"version" : "1.0",
"modules" : [ {
"createdBy" : "bumlux",
"createdAt" : 1564644013689,
"lastModifiedBy" : "bumlux",
"lastModifiedAt" : 1564644013761,
"name" : "Firmware",
"description" : "Description of the software module",
"version" : "1.0.33",
"type" : "os",
"vendor" : "vendor Limited Inc, California",
"deleted" : false,
"links" : [ {
"rel" : "self",
"href" : "https://management-api.host.com/rest/v1/softwaremodules/27",
"hreflang" : null,
"media" : null,
"title" : null,
"type" : null,
"deprecation" : null
} ],
"id" : 27
}, {
"createdBy" : "bumlux",
"createdAt" : 1564644013675,
"lastModifiedBy" : "bumlux",
"lastModifiedAt" : 1564644013732,
"name" : "application",
"description" : "Description of the software module",
"version" : "1.0.92",
"type" : "application",
"vendor" : "vendor Limited, California",
"deleted" : false,
"links" : [ {
"rel" : "self",
"href" : "https://management-api.host.com/rest/v1/softwaremodules/25",
"hreflang" : null,
"media" : null,
"title" : null,
"type" : null,
"deprecation" : null
} ],
"id" : 25
}, {
"createdBy" : "bumlux",
"createdAt" : 1564644013682,
"lastModifiedBy" : "bumlux",
"lastModifiedAt" : 1564644013747,
"name" : "app runtime",
"description" : "Description of the software module",
"version" : "1.0.22",
"type" : "runtime",
"vendor" : "vendor GmbH, Stuttgart, Germany",
"deleted" : false,
"links" : [ {
"rel" : "self",
"href" : "https://management-api.host.com/rest/v1/softwaremodules/26",
"hreflang" : null,
"media" : null,
"title" : null,
"type" : null,
"deprecation" : null
} ],
"id" : 26
} ],
"requiredMigrationStep" : false,
"type" : "test_default_ds_type",
"complete" : true,
"deleted" : false,
"links" : [ {
"rel" : "self",
"href" : "https://management-api.host.com/rest/v1/distributionsets/9",
"hreflang" : null,
"media" : null,
"title" : null,
"type" : null,
"deprecation" : null
} ],
"id" : 9
} ],
"unassignedDistributionSets" : [ ]
}
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. |
|
|
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. |
POST /rest/v1/distributionsettags/{distributionsetTagId}/distributionsets
Implementation Notes
Handles the POST request of distribution assignment. Already assigned distribution will be ignored.
Distribution assignment
CURL
$ curl 'https://management-api.host.com/rest/v1/distributionsettags/8/assigned' -i -X POST \
-H 'Content-Type: application/json;charset=UTF-8' \
-d '[ {
"id" : 8
} ]'
Request URL
POST /rest/v1/distributionsettags/8/assigned HTTP/1.1
Content-Length: 18
Content-Type: application/json;charset=UTF-8
Host: management-api.host.com
[ {
"id" : 8
} ]
Request fields
Path | Type | Description | Allowed Values | Mandatory |
---|---|---|---|---|
[]id |
Number |
The technical identifier of the entity |
X |
Response (Status 200)
Response fields
Path | Type | Description | Allowed Values |
---|---|---|---|
[]id |
Number |
The technical identifier of the entity |
|
[]name |
String |
The name of the entity |
|
[]description |
String |
The description of the entity |
|
[]createdBy |
String |
Entity was originally created by User, AMQP-Controller, anonymous etc.) |
|
[]createdAt |
Number |
Entity was originally created at (timestamp UTC in milliseconds) |
|
[]lastModifiedBy |
String |
Entity was last modified by User, AMQP-Controller, anonymous etc.) |
|
[]lastModifiedAt |
Number |
Entity was last modified at (timestamp UTC in milliseconds) |
|
[]type |
String |
The type of the distribution set. |
|
[]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) |
|
[]complete |
Boolean |
True of the distribution set software module setup is complete as defined by the distribution set type. |
|
[]deleted |
Boolean |
Deleted flag, used for soft deleted entities |
|
[]version |
String |
Package version. |
Response example
HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1944
[ {
"createdBy" : "bumlux",
"createdAt" : 1564644008472,
"lastModifiedBy" : "bumlux",
"lastModifiedAt" : 1564644008549,
"name" : "DS",
"description" : "The descption of the distribution set.",
"version" : "1.0",
"modules" : [ {
"createdBy" : "bumlux",
"createdAt" : 1564644008455,
"lastModifiedBy" : "bumlux",
"lastModifiedAt" : 1564644008511,
"name" : "Firmware",
"description" : "Description of the software module",
"version" : "1.0.48",
"type" : "os",
"vendor" : "vendor Limited Inc, California",
"deleted" : false,
"_links" : {
"self" : {
"href" : "https://management-api.host.com/rest/v1/softwaremodules/24"
}
},
"id" : 24
}, {
"createdBy" : "bumlux",
"createdAt" : 1564644008443,
"lastModifiedBy" : "bumlux",
"lastModifiedAt" : 1564644008527,
"name" : "application",
"description" : "Description of the software module",
"version" : "1.0.67",
"type" : "application",
"vendor" : "vendor Limited, California",
"deleted" : false,
"_links" : {
"self" : {
"href" : "https://management-api.host.com/rest/v1/softwaremodules/22"
}
},
"id" : 22
}, {
"createdBy" : "bumlux",
"createdAt" : 1564644008449,
"lastModifiedBy" : "bumlux",
"lastModifiedAt" : 1564644008496,
"name" : "app runtime",
"description" : "Description of the software module",
"version" : "1.0.11",
"type" : "runtime",
"vendor" : "vendor GmbH, Stuttgart, Germany",
"deleted" : false,
"_links" : {
"self" : {
"href" : "https://management-api.host.com/rest/v1/softwaremodules/23"
}
},
"id" : 23
} ],
"requiredMigrationStep" : false,
"type" : "test_default_ds_type",
"complete" : true,
"deleted" : false,
"_links" : {
"self" : {
"href" : "https://management-api.host.com/rest/v1/distributionsets/8"
}
},
"id" : 8
} ]
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. |
|
|
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. |
DELETE /rest/v1/distributionsettags/{distributionsetTagId}/distributionsets/{distributionsetId}
Implementation Notes
Handles the DELETE request of unassign the given distribution.
Unassign a distribution
CURL
$ curl 'https://management-api.host.com/rest/v1/distributionsettags/10/assigned/11' -i -X DELETE \
-H 'Content-Type: application/json;charset=UTF-8'
Request URL
DELETE /rest/v1/distributionsettags/10/assigned/11 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: management-api.host.com
Request path parameter
Parameter | Description |
---|---|
distributionsetTagId |
The technical identifier of the entity |
distributionsetId |
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 |
|
Not Found Target. |
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 |