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

limit

The maximum number of entries in a page (default is 50).

sort

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.

offset

The paging offset (default is 0).

q

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 distribution set tags

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
Content-Length: 419

{
  "content" : [ {
    "createdBy" : "bumlux",
    "createdAt" : 1691065745487,
    "lastModifiedBy" : "bumlux",
    "lastModifiedAt" : 1691065745623,
    "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

400 Bad Request

Bad Request - e.g. invalid parameters

401 Unauthorized

The request requires user authentication.

403 Forbidden

Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.

See Error body

405 Method Not Allowed

The http request method is not allowed on the resource.

406 Not Acceptable

In case accept header is specified and not application/json.

429 Too Many Request

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
Content-Length: 488

{
  "createdBy" : "bumlux",
  "createdAt" : 1691065761930,
  "lastModifiedBy" : "bumlux",
  "lastModifiedAt" : 1691065762080,
  "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"
    }
  },
  "id" : 6
}

Error responses

HTTP Status Code Reason Response Model

400 Bad Request

Bad Request - e.g. invalid parameters

401 Unauthorized

The request requires user authentication.

403 Forbidden

Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.

See Error body

405 Method Not Allowed

The http request method is not allowed on the resource.

406 Not Acceptable

In case accept header is specified and not application/json.

429 Too Many Request

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' \
    -d '[ {
  "colour" : "red",
  "name" : "ds tag",
  "description" : "ds tag description"
} ]'

Request URL

POST /rest/v1/distributionsettags HTTP/1.1
Content-Type: application/json
Content-Length: 87
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
Content-Length: 343

[ {
  "createdBy" : "bumlux",
  "createdAt" : 1691065764726,
  "lastModifiedBy" : "bumlux",
  "lastModifiedAt" : 1691065764726,
  "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

400 Bad Request

Bad Request - e.g. invalid parameters

401 Unauthorized

The request requires user authentication.

403 Forbidden

Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.

See Error body

405 Method Not Allowed

The http request method is not allowed on the resource.

406 Not Acceptable

In case accept header is specified and not application/json.

409 Conflict

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

415 Unsupported Media Type

The request was attempt with a media-type which is not supported by the server for this resource.

429 Too Many Request

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' \
    -d '{
  "colour" : "red",
  "name" : "ds tag",
  "description" : "ds tag description"
}'

Request URL

PUT /rest/v1/distributionsettags/1 HTTP/1.1
Content-Type: application/json
Content-Length: 83
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
Content-Length: 487

{
  "createdBy" : "bumlux",
  "createdAt" : 1691065735278,
  "lastModifiedBy" : "bumlux",
  "lastModifiedAt" : 1691065736885,
  "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"
    }
  },
  "id" : 1
}

Error responses

HTTP Status Code Reason Response Model

400 Bad Request

Bad Request - e.g. invalid parameters

401 Unauthorized

The request requires user authentication.

403 Forbidden

Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.

See Error body

404 Not Found

Not Found Target.

See Error body

405 Method Not Allowed

The http request method is not allowed on the resource.

406 Not Acceptable

In case accept header is specified and not application/json.

409 Conflict

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

415 Unsupported Media Type

The request was attempt with a media-type which is not supported by the server for this resource.

429 Too Many Request

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'

Request URL

DELETE /rest/v1/distributionsettags/4 HTTP/1.1
Content-Type: application/json
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

400 Bad Request

Bad Request - e.g. invalid parameters

401 Unauthorized

The request requires user authentication.

403 Forbidden

Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.

See Error body

404 Not Found

Not Found Target.

See Error body

405 Method Not Allowed

The http request method is not allowed on the resource.

406 Not Acceptable

In case accept header is specified and not application/json.

409 Conflict

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

415 Unsupported Media Type

The request was attempt with a media-type which is not supported by the server for this resource.

429 Too Many Request

Too many requests. The server will refuse further attempts and the client has to wait another second.

GET /rest/v1/distributionsettags/{distributionsetTagId}/assigned

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'

Request URL

GET /rest/v1/distributionsettags/3/assigned HTTP/1.1
Content-Type: application/json
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[].typeName

String

The type name 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[].valid

Boolean

True by default and false after the distribution set is invalidated by the user.

content[].version

String

Package version.

size

Number

Current page size

total

Number

Total number of elements

content

Array

List of distribution set tags

Response example

HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 2389

{
  "content" : [ {
    "createdBy" : "bumlux",
    "createdAt" : 1691065749230,
    "lastModifiedBy" : "bumlux",
    "lastModifiedAt" : 1691065750836,
    "name" : "DS",
    "description" : "The descption of the distribution set.",
    "version" : "1.0",
    "modules" : [ {
      "createdBy" : "bumlux",
      "createdAt" : 1691065748799,
      "lastModifiedBy" : "bumlux",
      "lastModifiedAt" : 1691065750134,
      "name" : "app runtime",
      "description" : "Description of the software module",
      "version" : "1.0.95",
      "type" : "runtime",
      "typeName" : "runtime",
      "vendor" : "vendor GmbH, Stuttgart, Germany",
      "deleted" : false,
      "encrypted" : false,
      "_links" : {
        "self" : {
          "href" : "https://management-api.host.com/rest/v1/softwaremodules/8"
        }
      },
      "id" : 8
    }, {
      "createdBy" : "bumlux",
      "createdAt" : 1691065748547,
      "lastModifiedBy" : "bumlux",
      "lastModifiedAt" : 1691065750400,
      "name" : "application",
      "description" : "Description of the software module",
      "version" : "1.0.10",
      "type" : "application",
      "typeName" : "Application",
      "vendor" : "vendor Limited, California",
      "deleted" : false,
      "encrypted" : false,
      "_links" : {
        "self" : {
          "href" : "https://management-api.host.com/rest/v1/softwaremodules/7"
        }
      },
      "id" : 7
    }, {
      "createdBy" : "bumlux",
      "createdAt" : 1691065748910,
      "lastModifiedBy" : "bumlux",
      "lastModifiedAt" : 1691065749793,
      "name" : "Firmware",
      "description" : "Description of the software module",
      "version" : "1.0.70",
      "type" : "os",
      "typeName" : "OS",
      "vendor" : "vendor Limited Inc, California",
      "deleted" : false,
      "encrypted" : false,
      "_links" : {
        "self" : {
          "href" : "https://management-api.host.com/rest/v1/softwaremodules/9"
        }
      },
      "id" : 9
    } ],
    "requiredMigrationStep" : false,
    "type" : "test_default_ds_type",
    "typeName" : "OS (FW) mandatory, runtime (FW) and app (SW) optional",
    "complete" : true,
    "deleted" : false,
    "valid" : true,
    "_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

400 Bad Request

Bad Request - e.g. invalid parameters

401 Unauthorized

The request requires user authentication.

403 Forbidden

Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.

See Error body

404 Not Found

Not Found Target.

See Error body

405 Method Not Allowed

The http request method is not allowed on the resource.

406 Not Acceptable

In case accept header is specified and not application/json.

429 Too Many Request

Too many requests. The server will refuse further attempts and the client has to wait another second.

POST /rest/v1/distributionsettags/{distributionsetTagId}/assigned/toggleTagAssignment

Implementation Notes

Handles the POST request of toggle distribution assignment. The request body must always be a list of distributionSet ids.

Toggle distribution assignment

CURL

$ curl 'https://management-api.host.com/rest/v1/distributionsettags/9/assigned/toggleTagAssignment' -i -X POST \
    -H 'Content-Type: application/json' \
    -d '[ {
  "id" : 9
} ]'

Request URL

POST /rest/v1/distributionsettags/9/assigned/toggleTagAssignment HTTP/1.1
Content-Type: application/json
Content-Length: 18
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
Content-Length: 2407

{
  "assignedDistributionSets" : [ {
    "createdBy" : "bumlux",
    "createdAt" : 1691065770326,
    "lastModifiedBy" : "bumlux",
    "lastModifiedAt" : 1691065772298,
    "name" : "DS",
    "description" : "The descption of the distribution set.",
    "version" : "1.0",
    "modules" : [ {
      "createdBy" : "bumlux",
      "createdAt" : 1691065770128,
      "lastModifiedBy" : "bumlux",
      "lastModifiedAt" : 1691065771326,
      "name" : "Firmware",
      "description" : "Description of the software module",
      "version" : "1.0.96",
      "type" : "os",
      "typeName" : "OS",
      "vendor" : "vendor Limited Inc, California",
      "deleted" : false,
      "encrypted" : false,
      "links" : [ {
        "rel" : "self",
        "href" : "https://management-api.host.com/rest/v1/softwaremodules/27"
      } ],
      "id" : 27
    }, {
      "createdBy" : "bumlux",
      "createdAt" : 1691065769809,
      "lastModifiedBy" : "bumlux",
      "lastModifiedAt" : 1691065770839,
      "name" : "application",
      "description" : "Description of the software module",
      "version" : "1.0.67",
      "type" : "application",
      "typeName" : "Application",
      "vendor" : "vendor Limited, California",
      "deleted" : false,
      "encrypted" : false,
      "links" : [ {
        "rel" : "self",
        "href" : "https://management-api.host.com/rest/v1/softwaremodules/25"
      } ],
      "id" : 25
    }, {
      "createdBy" : "bumlux",
      "createdAt" : 1691065769978,
      "lastModifiedBy" : "bumlux",
      "lastModifiedAt" : 1691065771096,
      "name" : "app runtime",
      "description" : "Description of the software module",
      "version" : "1.0.12",
      "type" : "runtime",
      "typeName" : "runtime",
      "vendor" : "vendor GmbH, Stuttgart, Germany",
      "deleted" : false,
      "encrypted" : false,
      "links" : [ {
        "rel" : "self",
        "href" : "https://management-api.host.com/rest/v1/softwaremodules/26"
      } ],
      "id" : 26
    } ],
    "requiredMigrationStep" : false,
    "type" : "test_default_ds_type",
    "typeName" : "OS (FW) mandatory, runtime (FW) and app (SW) optional",
    "complete" : true,
    "deleted" : false,
    "valid" : true,
    "links" : [ {
      "rel" : "self",
      "href" : "https://management-api.host.com/rest/v1/distributionsets/9"
    } ],
    "id" : 9
  } ],
  "unassignedDistributionSets" : [ ]
}

Error responses

HTTP Status Code Reason Response Model

400 Bad Request

Bad Request - e.g. invalid parameters

401 Unauthorized

The request requires user authentication.

403 Forbidden

Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.

See Error body

405 Method Not Allowed

The http request method is not allowed on the resource.

406 Not Acceptable

In case accept header is specified and not application/json.

409 Conflict

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

415 Unsupported Media Type

The request was attempt with a media-type which is not supported by the server for this resource.

429 Too Many Request

Too many requests. The server will refuse further attempts and the client has to wait another second.

POST /rest/v1/distributionsettags/{distributionsetTagId}/assigned

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' \
    -d '[ {
  "id" : 8
} ]'

Request URL

POST /rest/v1/distributionsettags/8/assigned HTTP/1.1
Content-Type: application/json
Content-Length: 18
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.

[]typeName

String

The type name 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

[]valid

Boolean

True by default and false after the distribution set is invalidated by the user.

[]version

String

Package version.

Response example

HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 2192

[ {
  "createdBy" : "bumlux",
  "createdAt" : 1691065766724,
  "lastModifiedBy" : "bumlux",
  "lastModifiedAt" : 1691065768024,
  "name" : "DS",
  "description" : "The descption of the distribution set.",
  "version" : "1.0",
  "modules" : [ {
    "createdBy" : "bumlux",
    "createdAt" : 1691065766554,
    "lastModifiedBy" : "bumlux",
    "lastModifiedAt" : 1691065767385,
    "name" : "Firmware",
    "description" : "Description of the software module",
    "version" : "1.0.75",
    "type" : "os",
    "typeName" : "OS",
    "vendor" : "vendor Limited Inc, California",
    "deleted" : false,
    "encrypted" : false,
    "_links" : {
      "self" : {
        "href" : "https://management-api.host.com/rest/v1/softwaremodules/24"
      }
    },
    "id" : 24
  }, {
    "createdBy" : "bumlux",
    "createdAt" : 1691065766338,
    "lastModifiedBy" : "bumlux",
    "lastModifiedAt" : 1691065767697,
    "name" : "application",
    "description" : "Description of the software module",
    "version" : "1.0.44",
    "type" : "application",
    "typeName" : "Application",
    "vendor" : "vendor Limited, California",
    "deleted" : false,
    "encrypted" : false,
    "_links" : {
      "self" : {
        "href" : "https://management-api.host.com/rest/v1/softwaremodules/22"
      }
    },
    "id" : 22
  }, {
    "createdBy" : "bumlux",
    "createdAt" : 1691065766483,
    "lastModifiedBy" : "bumlux",
    "lastModifiedAt" : 1691065767094,
    "name" : "app runtime",
    "description" : "Description of the software module",
    "version" : "1.0.84",
    "type" : "runtime",
    "typeName" : "runtime",
    "vendor" : "vendor GmbH, Stuttgart, Germany",
    "deleted" : false,
    "encrypted" : false,
    "_links" : {
      "self" : {
        "href" : "https://management-api.host.com/rest/v1/softwaremodules/23"
      }
    },
    "id" : 23
  } ],
  "requiredMigrationStep" : false,
  "type" : "test_default_ds_type",
  "typeName" : "OS (FW) mandatory, runtime (FW) and app (SW) optional",
  "complete" : true,
  "deleted" : false,
  "valid" : true,
  "_links" : {
    "self" : {
      "href" : "https://management-api.host.com/rest/v1/distributionsets/8"
    }
  },
  "id" : 8
} ]

Error responses

HTTP Status Code Reason Response Model

400 Bad Request

Bad Request - e.g. invalid parameters

401 Unauthorized

The request requires user authentication.

403 Forbidden

Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.

See Error body

405 Method Not Allowed

The http request method is not allowed on the resource.

406 Not Acceptable

In case accept header is specified and not application/json.

409 Conflict

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

415 Unsupported Media Type

The request was attempt with a media-type which is not supported by the server for this resource.

429 Too Many Request

Too many requests. The server will refuse further attempts and the client has to wait another second.

DELETE /rest/v1/distributionsettags/{distributionsetTagId}/assigned/{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'

Request URL

DELETE /rest/v1/distributionsettags/10/assigned/11 HTTP/1.1
Content-Type: application/json
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

400 Bad Request

Bad Request - e.g. invalid parameters

401 Unauthorized

The request requires user authentication.

403 Forbidden

Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.

See Error body

404 Not Found

Not Found Target.

See Error body

405 Method Not Allowed

The http request method is not allowed on the resource.

406 Not Acceptable

In case accept header is specified and not application/json.

429 Too Many Request

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

© Bosch.IO GmbH, all rights reserved Corporate information | Data protection notice | Legal information | Support | Free plans