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

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/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
Content-Length: 1748

{
  "content" : [ {
    "createdBy" : "system",
    "createdAt" : 1629287324929,
    "lastModifiedBy" : "system",
    "lastModifiedAt" : 1629287324929,
    "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/15"
      }
    },
    "id" : 15
  }, {
    "createdBy" : "system",
    "createdAt" : 1629287324928,
    "lastModifiedBy" : "system",
    "lastModifiedAt" : 1629287324928,
    "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/16"
      }
    },
    "id" : 16
  }, {
    "createdBy" : "system",
    "createdAt" : 1629287324927,
    "lastModifiedBy" : "system",
    "lastModifiedAt" : 1629287324927,
    "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/17"
      }
    },
    "id" : 17
  }, {
    "createdBy" : "bumlux",
    "createdAt" : 1629287325174,
    "lastModifiedBy" : "bumlux",
    "lastModifiedAt" : 1629287325412,
    "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/18"
      }
    },
    "id" : 18
  } ],
  "total" : 4,
  "size" : 4
}

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/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 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -d '[ {
  "optionalmodules" : [ {
    "id" : 3
  } ],
  "name" : "TestName1",
  "description" : "Desc1",
  "mandatorymodules" : [ {
    "id" : 1
  } ],
  "key" : "test1"
} ]'

Request URL

POST /rest/v1/distributionsettypes HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 169
Host: management-api.host.com

[ {
  "optionalmodules" : [ {
    "id" : 3
  } ],
  "name" : "TestName1",
  "description" : "Desc1",
  "mandatorymodules" : [ {
    "id" : 1
  } ],
  "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-Type: application/json
Content-Length: 366

[ {
  "createdBy" : "uploadTester",
  "createdAt" : 1629287321842,
  "lastModifiedBy" : "uploadTester",
  "lastModifiedAt" : 1629287321842,
  "name" : "TestName1",
  "description" : "Desc1",
  "key" : "test1",
  "deleted" : false,
  "_links" : {
    "self" : {
      "href" : "https://management-api.host.com/rest/v1/distributionsettypes/5"
    }
  },
  "id" : 5
} ]

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

Distribution set type was not found.

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

Distribution set type already exists

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/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/41' -i -X DELETE

Request URL

DELETE /rest/v1/distributionsettypes/41 HTTP/1.1
Host: management-api.host.com

Request path parameter

Parameter Description

distributionSetTypeId

The technical identifier of the entity

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

Distribution set type was not found.

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/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/14' -i -X GET \
    -H 'Accept: application/json'

Request URL

GET /rest/v1/distributionsettypes/14 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-Type: application/json
Content-Length: 684

{
  "createdBy" : "bumlux",
  "createdAt" : 1629287324089,
  "lastModifiedBy" : "bumlux",
  "lastModifiedAt" : 1629287324707,
  "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/14"
    },
    "mandatorymodules" : {
      "href" : "https://management-api.host.com/rest/v1/distributionsettypes/14/mandatorymoduletypes"
    },
    "optionalmodules" : {
      "href" : "https://management-api.host.com/rest/v1/distributionsettypes/14/optionalmoduletypes"
    }
  },
  "id" : 14
}

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

Distribution set type was not found.

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.

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/45' -i -X PUT \
    -H 'Content-Type: application/json' \
    -d '{
  "description" : "an updated desription"
}'

Request URL

PUT /rest/v1/distributionsettypes/45 HTTP/1.1
Content-Type: application/json
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
Content-Length: 697

{
  "createdBy" : "bumlux",
  "createdAt" : 1629287327639,
  "lastModifiedBy" : "bumlux",
  "lastModifiedAt" : 1629287327827,
  "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/45"
    },
    "mandatorymodules" : {
      "href" : "https://management-api.host.com/rest/v1/distributionsettypes/45/mandatorymoduletypes"
    },
    "optionalmodules" : {
      "href" : "https://management-api.host.com/rest/v1/distributionsettypes/45/optionalmoduletypes"
    }
  },
  "id" : 45
}

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

Distribution set type was not found.

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/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/32/mandatorymoduletypes' -i -X GET \
    -H 'Accept: application/json'

Request URL

GET /rest/v1/distributionsettypes/32/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" : 1629287326399,
  "lastModifiedBy" : "bumlux",
  "lastModifiedAt" : 1629287326443,
  "name" : "OS",
  "description" : "Updated description.",
  "key" : "os",
  "maxAssignments" : 1,
  "deleted" : false,
  "_links" : {
    "self" : {
      "href" : "https://management-api.host.com/rest/v1/softwaremoduletypes/19"
    }
  },
  "id" : 19
} ]

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

Distribution set type was not found.

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/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/27/mandatorymoduletypes' -i -X POST \
    -H 'Content-Type: application/json' \
    -d '{
  "id" : 17
}'

Request URL

POST /rest/v1/distributionsettypes/27/mandatorymoduletypes HTTP/1.1
Content-Type: application/json
Content-Length: 15
Host: management-api.host.com

{
  "id" : 17
}

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

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

Distribution set type was not found.

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

Distribution set type already exists

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/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/59/mandatorymoduletypes/37' -i -X DELETE \
    -H 'Content-Type: application/json'

Request URL

DELETE /rest/v1/distributionsettypes/59/mandatorymoduletypes/37 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

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

Distribution set type was not found.

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/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/50/mandatorymoduletypes/31' -i -X GET \
    -H 'Content-Type: application/json'

Request URL

GET /rest/v1/distributionsettypes/50/mandatorymoduletypes/31 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" : 1629287327931,
  "lastModifiedBy" : "bumlux",
  "lastModifiedAt" : 1629287327956,
  "name" : "OS",
  "description" : "Updated description.",
  "key" : "os",
  "maxAssignments" : 1,
  "deleted" : false,
  "_links" : {
    "self" : {
      "href" : "https://management-api.host.com/rest/v1/softwaremoduletypes/31"
    }
  },
  "id" : 31
}

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

Distribution set type was not found.

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/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/37/optionalmoduletypes' -i -X GET \
    -H 'Accept: application/json'

Request URL

GET /rest/v1/distributionsettypes/37/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-Type: application/json
Content-Length: 394

[ {
  "createdBy" : "bumlux",
  "createdAt" : 1629287326826,
  "lastModifiedBy" : "bumlux",
  "lastModifiedAt" : 1629287326851,
  "name" : "runtime",
  "description" : "Updated description.",
  "key" : "runtime",
  "maxAssignments" : 1,
  "deleted" : false,
  "_links" : {
    "self" : {
      "href" : "https://management-api.host.com/rest/v1/softwaremoduletypes/24"
    }
  },
  "id" : 24
} ]

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

Distribution set type was not found.

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/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/64/optionalmoduletypes' -i -X POST \
    -H 'Content-Type: application/json' \
    -d '{
  "id" : 41
}'

Request URL

POST /rest/v1/distributionsettypes/64/optionalmoduletypes HTTP/1.1
Content-Type: application/json
Content-Length: 15
Host: management-api.host.com

{
  "id" : 41
}

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

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

Distribution set type was not found.

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

Distribution set type already exists

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/distributionsettypes/{distributionSetTypeId}/optionalmoduletypes/{softwareModuleTypeId}

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/69/optionalmoduletypes/43' -i -X DELETE \
    -H 'Content-Type: application/json'

Request URL

DELETE /rest/v1/distributionsettypes/69/optionalmoduletypes/43 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

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

Distribution set type was not found.

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/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/10/optionalmoduletypes/5' -i -X GET \
    -H 'Content-Type: application/json'

Request URL

GET /rest/v1/distributionsettypes/10/optionalmoduletypes/5 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: 405

{
  "createdBy" : "system",
  "createdAt" : 1629287322703,
  "lastModifiedBy" : "bumlux",
  "lastModifiedAt" : 1629287322862,
  "name" : "Application",
  "description" : "Updated description.",
  "key" : "application",
  "maxAssignments" : 2147483647,
  "deleted" : false,
  "_links" : {
    "self" : {
      "href" : "https://management-api.host.com/rest/v1/softwaremoduletypes/5"
    }
  },
  "id" : 5
}

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

Distribution set type was not found.

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