GET /rest/v1/distributionsets

Implementation notes

Handles the GET request of retrieving all distribution sets within SP. Required permission: READ_REPOSITORY

Get paged list of Distribution Sets

Curl

$ curl 'https://management-api.host.com/rest/v1/distributionsets' -i -X GET \
    -H 'Accept: application/json'

Request URL

GET /rest/v1/distributionsets 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 query parameter example

GET /rest/v1/distributionsets?offset=1&limit=2&sort=version%3ADESC&q=name%3D%3DtestDS* HTTP/1.1
Accept: application/json
Host: management-api.host.com

Response (Status 200)

Response fields

Path Type Description Allowed Values

total

Number

Total number of elements

size

Number

Current page size

content

Array

List of distribution sets.

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.

Response example

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 2329

{
  "content" : [ {
    "createdBy" : "bumlux",
    "createdAt" : 1629287408703,
    "lastModifiedBy" : "bumlux",
    "lastModifiedAt" : 1629287408709,
    "name" : "DS",
    "description" : "Updated Desc: parturient sapien luctus erat pretium cum venenatis ante velit sodales",
    "version" : "1.0",
    "modules" : [ {
      "createdBy" : "bumlux",
      "createdAt" : 1629287408684,
      "lastModifiedBy" : "bumlux",
      "lastModifiedAt" : 1629287408726,
      "name" : "Firmware",
      "description" : "Updated Desc: parturient sapien luctus erat pretium cum venenatis ante velit sodales",
      "version" : "1.0.88",
      "type" : "os",
      "vendor" : "vendor Limited Inc, California",
      "deleted" : false,
      "_links" : {
        "self" : {
          "href" : "https://management-api.host.com/rest/v1/softwaremodules/73"
        }
      },
      "id" : 73
    }, {
      "createdBy" : "bumlux",
      "createdAt" : 1629287408666,
      "lastModifiedBy" : "bumlux",
      "lastModifiedAt" : 1629287408716,
      "name" : "application",
      "description" : "Updated Desc: parturient sapien luctus erat pretium cum venenatis ante velit sodales",
      "version" : "1.0.79",
      "type" : "application",
      "vendor" : "vendor Limited, California",
      "deleted" : false,
      "_links" : {
        "self" : {
          "href" : "https://management-api.host.com/rest/v1/softwaremodules/71"
        }
      },
      "id" : 71
    }, {
      "createdBy" : "bumlux",
      "createdAt" : 1629287408674,
      "lastModifiedBy" : "bumlux",
      "lastModifiedAt" : 1629287408721,
      "name" : "app runtime",
      "description" : "Updated Desc: parturient sapien luctus erat pretium cum venenatis ante velit sodales",
      "version" : "1.0.94",
      "type" : "runtime",
      "vendor" : "vendor GmbH, Stuttgart, Germany",
      "deleted" : false,
      "_links" : {
        "self" : {
          "href" : "https://management-api.host.com/rest/v1/softwaremodules/72"
        }
      },
      "id" : 72
    } ],
    "requiredMigrationStep" : false,
    "type" : "test_default_ds_type",
    "complete" : true,
    "deleted" : false,
    "_links" : {
      "self" : {
        "href" : "https://management-api.host.com/rest/v1/distributionsets/27"
      }
    },
    "id" : 27
  } ],
  "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.

POST /rest/v1/distributionsets

Implementation Notes

Handles the POST request of creating new distribution sets within SP. The request body must always be a list of sets. Required permission: CREATE_REPOSITORY

Create Distribution Sets

CURL

$ curl 'https://management-api.host.com/rest/v1/distributionsets/' -i -X POST \
    -H 'Content-Type: application/json' \
    -d '[ {
  "requiredMigrationStep" : false,
  "name" : "one",
  "description" : "ullamcorper ridiculus aenean condimentum fringilla primis aenean sem interdum praesent",
  "type" : "test_default_ds_type",
  "version" : "one",
  "modules" : [ {
    "id" : 69
  }, {
    "id" : 70
  } ]
}, {
  "requiredMigrationStep" : false,
  "name" : "two",
  "description" : "litora non cras egestas feugiat varius sollicitudin porta volutpat eros",
  "type" : "test_default_ds_type",
  "version" : "two",
  "modules" : [ {
    "id" : 69
  }, {
    "id" : 70
  } ]
}, {
  "requiredMigrationStep" : true,
  "name" : "three",
  "description" : "nostra dui aliquet morbi venenatis curabitur diam porta himenaeos senectus",
  "type" : "test_default_ds_type",
  "version" : "three",
  "modules" : [ {
    "id" : 69
  }, {
    "id" : 70
  } ]
} ]'

Request URL

POST /rest/v1/distributionsets/ HTTP/1.1
Content-Type: application/json
Content-Length: 821
Host: management-api.host.com

[ {
  "requiredMigrationStep" : false,
  "name" : "one",
  "description" : "ullamcorper ridiculus aenean condimentum fringilla primis aenean sem interdum praesent",
  "type" : "test_default_ds_type",
  "version" : "one",
  "modules" : [ {
    "id" : 69
  }, {
    "id" : 70
  } ]
}, {
  "requiredMigrationStep" : false,
  "name" : "two",
  "description" : "litora non cras egestas feugiat varius sollicitudin porta volutpat eros",
  "type" : "test_default_ds_type",
  "version" : "two",
  "modules" : [ {
    "id" : 69
  }, {
    "id" : 70
  } ]
}, {
  "requiredMigrationStep" : true,
  "name" : "three",
  "description" : "nostra dui aliquet morbi venenatis curabitur diam porta himenaeos senectus",
  "type" : "test_default_ds_type",
  "version" : "three",
  "modules" : [ {
    "id" : 69
  }, {
    "id" : 70
  } ]
} ]

Request fields

Path Type Description Allowed Values Mandatory

[]name

String

The name of the entity

X

[]description

String

The description of the entity

X

[]version

String

Package version.

X

[]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)

[]type

String

The type of the distribution set.

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 201 Created
Content-Type: application/hal+json
Content-Length: 4652

[ {
  "createdBy" : "bumlux",
  "createdAt" : 1629287408531,
  "lastModifiedBy" : "bumlux",
  "lastModifiedAt" : 1629287408531,
  "name" : "one",
  "description" : "ullamcorper ridiculus aenean condimentum fringilla primis aenean sem interdum praesent",
  "version" : "one",
  "modules" : [ {
    "createdBy" : "bumlux",
    "createdAt" : 1629287408456,
    "lastModifiedBy" : "bumlux",
    "lastModifiedAt" : 1629287408456,
    "name" : "application",
    "description" : "morbi odio est fringilla pharetra tortor felis pellentesque sodales nisl",
    "version" : "1.0",
    "type" : "application",
    "vendor" : "Vendor Limited, California",
    "deleted" : false,
    "_links" : {
      "self" : {
        "href" : "https://management-api.host.com/rest/v1/softwaremodules/69"
      }
    },
    "id" : 69
  }, {
    "createdBy" : "bumlux",
    "createdAt" : 1629287408466,
    "lastModifiedBy" : "bumlux",
    "lastModifiedAt" : 1629287408466,
    "name" : "os",
    "description" : "tincidunt urna urna nunc facilisi consequat ad arcu pulvinar lacus",
    "version" : "1.0",
    "type" : "os",
    "vendor" : "Vendor Limited, California",
    "deleted" : false,
    "_links" : {
      "self" : {
        "href" : "https://management-api.host.com/rest/v1/softwaremodules/70"
      }
    },
    "id" : 70
  } ],
  "requiredMigrationStep" : false,
  "type" : "test_default_ds_type",
  "complete" : true,
  "deleted" : false,
  "_links" : {
    "self" : {
      "href" : "https://management-api.host.com/rest/v1/distributionsets/26"
    }
  },
  "id" : 26
}, {
  "createdBy" : "bumlux",
  "createdAt" : 1629287408534,
  "lastModifiedBy" : "bumlux",
  "lastModifiedAt" : 1629287408534,
  "name" : "two",
  "description" : "litora non cras egestas feugiat varius sollicitudin porta volutpat eros",
  "version" : "two",
  "modules" : [ {
    "createdBy" : "bumlux",
    "createdAt" : 1629287408456,
    "lastModifiedBy" : "bumlux",
    "lastModifiedAt" : 1629287408456,
    "name" : "application",
    "description" : "morbi odio est fringilla pharetra tortor felis pellentesque sodales nisl",
    "version" : "1.0",
    "type" : "application",
    "vendor" : "Vendor Limited, California",
    "deleted" : false,
    "_links" : {
      "self" : {
        "href" : "https://management-api.host.com/rest/v1/softwaremodules/69"
      }
    },
    "id" : 69
  }, {
    "createdBy" : "bumlux",
    "createdAt" : 1629287408466,
    "lastModifiedBy" : "bumlux",
    "lastModifiedAt" : 1629287408466,
    "name" : "os",
    "description" : "tincidunt urna urna nunc facilisi consequat ad arcu pulvinar lacus",
    "version" : "1.0",
    "type" : "os",
    "vendor" : "Vendor Limited, California",
    "deleted" : false,
    "_links" : {
      "self" : {
        "href" : "https://management-api.host.com/rest/v1/softwaremodules/70"
      }
    },
    "id" : 70
  } ],
  "requiredMigrationStep" : false,
  "type" : "test_default_ds_type",
  "complete" : true,
  "deleted" : false,
  "_links" : {
    "self" : {
      "href" : "https://management-api.host.com/rest/v1/distributionsets/24"
    }
  },
  "id" : 24
}, {
  "createdBy" : "bumlux",
  "createdAt" : 1629287408540,
  "lastModifiedBy" : "bumlux",
  "lastModifiedAt" : 1629287408540,
  "name" : "three",
  "description" : "nostra dui aliquet morbi venenatis curabitur diam porta himenaeos senectus",
  "version" : "three",
  "modules" : [ {
    "createdBy" : "bumlux",
    "createdAt" : 1629287408456,
    "lastModifiedBy" : "bumlux",
    "lastModifiedAt" : 1629287408456,
    "name" : "application",
    "description" : "morbi odio est fringilla pharetra tortor felis pellentesque sodales nisl",
    "version" : "1.0",
    "type" : "application",
    "vendor" : "Vendor Limited, California",
    "deleted" : false,
    "_links" : {
      "self" : {
        "href" : "https://management-api.host.com/rest/v1/softwaremodules/69"
      }
    },
    "id" : 69
  }, {
    "createdBy" : "bumlux",
    "createdAt" : 1629287408466,
    "lastModifiedBy" : "bumlux",
    "lastModifiedAt" : 1629287408466,
    "name" : "os",
    "description" : "tincidunt urna urna nunc facilisi consequat ad arcu pulvinar lacus",
    "version" : "1.0",
    "type" : "os",
    "vendor" : "Vendor Limited, California",
    "deleted" : false,
    "_links" : {
      "self" : {
        "href" : "https://management-api.host.com/rest/v1/softwaremodules/70"
      }
    },
    "id" : 70
  } ],
  "requiredMigrationStep" : true,
  "type" : "test_default_ds_type",
  "complete" : true,
  "deleted" : false,
  "_links" : {
    "self" : {
      "href" : "https://management-api.host.com/rest/v1/distributionsets/25"
    }
  },
  "id" : 25
} ]

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/distributionsets/{distributionSetId}

Implementation Notes

Handles the DELETE request for a single Distribution Set within SP. Required permission: DELETE_REPOSITORY

Delete Distribution Set

CURL

$ curl 'https://management-api.host.com/rest/v1/distributionsets/9' -i -X DELETE

Request URL

DELETE /rest/v1/distributionsets/9 HTTP/1.1
Host: management-api.host.com

Request path parameter

Parameter Description

distributionSetId

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

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.

GET /rest/v1/distributionsets/{distributionSetId}

Implementation Notes

Handles the GET request of retrieving a single distribution set within SP. Required permission: READ_REPOSITORY

Get Distribution Set

CURL

$ curl 'https://management-api.host.com/rest/v1/distributionsets/5' -i -X GET \
    -H 'Accept: application/json'

Request URL

GET /rest/v1/distributionsets/5 HTTP/1.1
Accept: application/json
Host: management-api.host.com

Request path parameter

Parameter Description

distributionSetId

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)

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.

_links.type

Object

The type of the distribution set.

_links.metadata

Object

List of metadata.

_links.modules

Object

List of software modules.

Response example

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 2566

{
  "createdBy" : "bumlux",
  "createdAt" : 1629287404709,
  "lastModifiedBy" : "bumlux",
  "lastModifiedAt" : 1629287404716,
  "name" : "DS",
  "description" : "Updated Desc: parturient sapien luctus erat pretium cum venenatis ante velit sodales",
  "version" : "1.0",
  "modules" : [ {
    "createdBy" : "bumlux",
    "createdAt" : 1629287404691,
    "lastModifiedBy" : "bumlux",
    "lastModifiedAt" : 1629287404734,
    "name" : "Firmware",
    "description" : "Updated Desc: parturient sapien luctus erat pretium cum venenatis ante velit sodales",
    "version" : "1.0.58",
    "type" : "os",
    "vendor" : "vendor Limited Inc, California",
    "deleted" : false,
    "_links" : {
      "self" : {
        "href" : "https://management-api.host.com/rest/v1/softwaremodules/15"
      }
    },
    "id" : 15
  }, {
    "createdBy" : "bumlux",
    "createdAt" : 1629287404670,
    "lastModifiedBy" : "bumlux",
    "lastModifiedAt" : 1629287404724,
    "name" : "application",
    "description" : "Updated Desc: parturient sapien luctus erat pretium cum venenatis ante velit sodales",
    "version" : "1.0.60",
    "type" : "application",
    "vendor" : "vendor Limited, California",
    "deleted" : false,
    "_links" : {
      "self" : {
        "href" : "https://management-api.host.com/rest/v1/softwaremodules/13"
      }
    },
    "id" : 13
  }, {
    "createdBy" : "bumlux",
    "createdAt" : 1629287404684,
    "lastModifiedBy" : "bumlux",
    "lastModifiedAt" : 1629287404729,
    "name" : "app runtime",
    "description" : "Updated Desc: parturient sapien luctus erat pretium cum venenatis ante velit sodales",
    "version" : "1.0.37",
    "type" : "runtime",
    "vendor" : "vendor GmbH, Stuttgart, Germany",
    "deleted" : false,
    "_links" : {
      "self" : {
        "href" : "https://management-api.host.com/rest/v1/softwaremodules/14"
      }
    },
    "id" : 14
  } ],
  "requiredMigrationStep" : false,
  "type" : "test_default_ds_type",
  "complete" : true,
  "deleted" : false,
  "_links" : {
    "self" : {
      "href" : "https://management-api.host.com/rest/v1/distributionsets/5"
    },
    "modules" : {
      "href" : "https://management-api.host.com/rest/v1/distributionsets/5/assignedSM?offset=0&limit=50{&sort}",
      "templated" : true
    },
    "type" : {
      "href" : "https://management-api.host.com/rest/v1/distributionsettypes/20"
    },
    "metadata" : {
      "href" : "https://management-api.host.com/rest/v1/distributionsets/5/metadata?offset=0&limit=50{&sort,q}",
      "templated" : true
    }
  },
  "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

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.

PUT /rest/v1/distributionsets/{distributionSetId}

Implementation Notes

Handles the UPDATE request for a single Distribution Set within SP. Required permission: UPDATE_REPOSITORY

Updating a Distribution Set

Curl

$ curl 'https://management-api.host.com/rest/v1/distributionsets/11' -i -X PUT \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -d '{
  "requiredMigrationStep" : true,
  "name" : "another Name",
  "description" : "a new description",
  "version" : "another Version"
}'

Request URL

PUT /rest/v1/distributionsets/11 HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 135
Host: management-api.host.com

{
  "requiredMigrationStep" : true,
  "name" : "another Name",
  "description" : "a new description",
  "version" : "another Version"
}

Request path parameter

Parameter Description

distributionSetId

The technical identifier of the entity

Request fields

Path Type Description Allowed Values Mandatory

name

String

The name of the entity

version

String

Package version.

description

String

The description of the entity

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)

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.

_links.type

Object

The type of the distribution set.

_links.metadata

Object

List of metadata.

_links.modules

Object

List of software modules.

Response example

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 2524

{
  "createdBy" : "bumlux",
  "createdAt" : 1629287405611,
  "lastModifiedBy" : "bumlux",
  "lastModifiedAt" : 1629287405673,
  "name" : "another Name",
  "description" : "a new description",
  "version" : "another Version",
  "modules" : [ {
    "createdBy" : "bumlux",
    "createdAt" : 1629287405584,
    "lastModifiedBy" : "bumlux",
    "lastModifiedAt" : 1629287405643,
    "name" : "app runtime",
    "description" : "Updated Desc: parturient sapien luctus erat pretium cum venenatis ante velit sodales",
    "version" : "1.0.40",
    "type" : "runtime",
    "vendor" : "vendor GmbH, Stuttgart, Germany",
    "deleted" : false,
    "_links" : {
      "self" : {
        "href" : "https://management-api.host.com/rest/v1/softwaremodules/32"
      }
    },
    "id" : 32
  }, {
    "createdBy" : "bumlux",
    "createdAt" : 1629287405591,
    "lastModifiedBy" : "bumlux",
    "lastModifiedAt" : 1629287405653,
    "name" : "Firmware",
    "description" : "Updated Desc: parturient sapien luctus erat pretium cum venenatis ante velit sodales",
    "version" : "1.0.65",
    "type" : "os",
    "vendor" : "vendor Limited Inc, California",
    "deleted" : false,
    "_links" : {
      "self" : {
        "href" : "https://management-api.host.com/rest/v1/softwaremodules/33"
      }
    },
    "id" : 33
  }, {
    "createdBy" : "bumlux",
    "createdAt" : 1629287405576,
    "lastModifiedBy" : "bumlux",
    "lastModifiedAt" : 1629287405637,
    "name" : "application",
    "description" : "Updated Desc: parturient sapien luctus erat pretium cum venenatis ante velit sodales",
    "version" : "1.0.23",
    "type" : "application",
    "vendor" : "vendor Limited, California",
    "deleted" : false,
    "_links" : {
      "self" : {
        "href" : "https://management-api.host.com/rest/v1/softwaremodules/31"
      }
    },
    "id" : 31
  } ],
  "requiredMigrationStep" : true,
  "type" : "test_default_ds_type",
  "complete" : true,
  "deleted" : false,
  "_links" : {
    "self" : {
      "href" : "https://management-api.host.com/rest/v1/distributionsets/11"
    },
    "modules" : {
      "href" : "https://management-api.host.com/rest/v1/distributionsets/11/assignedSM?offset=0&limit=50{&sort}",
      "templated" : true
    },
    "type" : {
      "href" : "https://management-api.host.com/rest/v1/distributionsettypes/36"
    },
    "metadata" : {
      "href" : "https://management-api.host.com/rest/v1/distributionsets/11/metadata?offset=0&limit=50{&sort,q}",
      "templated" : true
    }
  },
  "id" : 11
}

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/distributionsets/{distributionSetId}/assignedSM

Implementation Notes

Handles the GET request of retrieving a single distribution set within SP. Required permission: READ_REPOSITORY

Get assigned Software Modules

Curl

$ curl 'https://management-api.host.com/rest/v1/distributionsets/17/assignedSM' -i -X GET \
    -H 'Accept: application/json'

Request URL

GET /rest/v1/distributionsets/17/assignedSM HTTP/1.1
Accept: application/json
Host: management-api.host.com

Request path parameter

Parameter Description

distributionSetId

The technical identifier of the entity

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/distributionsets/12/assignedSM?offset=1&limit=2&sort=version%3ADESC&q=name%3D%3Done* HTTP/1.1
Accept: application/json
Host: management-api.host.com

Response (Status 200)

Response fields

Path Type Description Allowed Values

total

Number

Total number of elements

size

Number

Current page size

content

Array

List of software modules.

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[].vendor

String

The software vendor.

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 software module type of the entity

content[].version

String

Package version.

Response example

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1656

{
  "content" : [ {
    "createdBy" : "bumlux",
    "createdAt" : 1629287407262,
    "lastModifiedBy" : "bumlux",
    "lastModifiedAt" : 1629287407310,
    "name" : "application",
    "description" : "Updated Desc: parturient sapien luctus erat pretium cum venenatis ante velit sodales",
    "version" : "1.0.36",
    "type" : "application",
    "vendor" : "vendor Limited, California",
    "deleted" : false,
    "_links" : {
      "self" : {
        "href" : "https://management-api.host.com/rest/v1/softwaremodules/49"
      }
    },
    "id" : 49
  }, {
    "createdBy" : "bumlux",
    "createdAt" : 1629287407268,
    "lastModifiedBy" : "bumlux",
    "lastModifiedAt" : 1629287407315,
    "name" : "app runtime",
    "description" : "Updated Desc: parturient sapien luctus erat pretium cum venenatis ante velit sodales",
    "version" : "1.0.12",
    "type" : "runtime",
    "vendor" : "vendor GmbH, Stuttgart, Germany",
    "deleted" : false,
    "_links" : {
      "self" : {
        "href" : "https://management-api.host.com/rest/v1/softwaremodules/50"
      }
    },
    "id" : 50
  }, {
    "createdBy" : "bumlux",
    "createdAt" : 1629287407275,
    "lastModifiedBy" : "bumlux",
    "lastModifiedAt" : 1629287407320,
    "name" : "Firmware",
    "description" : "Updated Desc: parturient sapien luctus erat pretium cum venenatis ante velit sodales",
    "version" : "1.0.18",
    "type" : "os",
    "vendor" : "vendor Limited Inc, California",
    "deleted" : false,
    "_links" : {
      "self" : {
        "href" : "https://management-api.host.com/rest/v1/softwaremodules/51"
      }
    },
    "id" : 51
  } ],
  "total" : 3,
  "size" : 3
}

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/distributionsets/{distributionSetId}/assignedSM

Implementation Notes

Handles the POST request for assigning multiple software modules to a distribution set.The request body must always be a list of software module IDs. Required permissions: READ_REPOSITORY and UPDATE_REPOSITORY

Assign Software Modules to Distribution Set

CURL

$ curl 'https://management-api.host.com/rest/v1/distributionsets/19/assignedSM' -i -X POST \
    -H 'Content-Type: application/json' \
    -d '[ {
  "id" : 55
}, {
  "id" : 56
} ]'

Request URL

POST /rest/v1/distributionsets/19/assignedSM HTTP/1.1
Content-Type: application/json
Content-Length: 36
Host: management-api.host.com

[ {
  "id" : 55
}, {
  "id" : 56
} ]

Request path parameter

Parameter Description

distributionSetId

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

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/distributionsets/{distributionSetId}/assignedSM/{softwareModuleId}

Implementation Notes

Delete a assignment. Required permission: UPDATE_REPOSITORY

Delete assignment of Software Module

CURL

$ curl 'https://management-api.host.com/rest/v1/distributionsets/4/assignedSM/12' -i -X DELETE \
    -H 'Content-Type: application/json'

Request URL

DELETE /rest/v1/distributionsets/4/assignedSM/12 HTTP/1.1
Content-Type: application/json
Host: management-api.host.com

Request path parameter

Parameter Description

distributionSetId

The technical identifier of the entity

softwareModuleId

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

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.

GET /rest/v1/distributionsets/{distributionSetId}/assignedTargets

Implementation Notes

Handles the GET request for retrieving assigned targets of a single distribution set. Required permissions: READ_REPOSITORY and READ_TARGET

Get assigned targets

Curl

$ curl 'https://management-api.host.com/rest/v1/distributionsets/3/assignedTargets' -i -X GET \
    -H 'Accept: application/json'

Request URL

GET /rest/v1/distributionsets/3/assignedTargets HTTP/1.1
Accept: application/json
Host: management-api.host.com

Request path parameter

Parameter Description

distributionSetId

The technical identifier of the entity

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/distributionsets/10/assignedTargets?offset=1&limit=2&sort=name%3ADESC&q=controllerId%3D%3Dtarget* HTTP/1.1
Accept: application/json
Host: management-api.host.com

Response (Status 200)

Response fields

Path Type Description Allowed Values

total

Number

Total number of elements

size

Number

Current page size

content

Array[Object]

List of provisioning targets.

Response example

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 501

{
  "content" : [ {
    "createdBy" : "bumlux",
    "createdAt" : 1629287404246,
    "lastModifiedBy" : "bumlux",
    "lastModifiedAt" : 1629287404285,
    "name" : "targetExist",
    "controllerId" : "targetExist",
    "updateStatus" : "pending",
    "securityToken" : "63cae5ac54a5cf6aafeac669945c0693",
    "requestAttributes" : true,
    "_links" : {
      "self" : {
        "href" : "https://management-api.host.com/rest/v1/targets/targetExist"
      }
    }
  } ],
  "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.

POST /rest/v1/distributionsets/{distributionSetId}/assignedTargets

Implementation Notes

Handles the POST request for assigning multiple targets to a distribution set.The request body must always be a list of target IDs. Required permissions: READ_REPOSITORY and UPDATE_TARGET

Assign targets to a distribution set

CURL

$ curl 'https://management-api.host.com/rest/v1/distributionsets/16/assignedTargets' -i -X POST \
    -H 'Content-Type: application/json' \
    -d '[ {
  "maintenanceWindow" : {
    "duration" : "00:10:00",
    "schedule" : "6 30 13 18 8 ? 2021",
    "timezone" : "+00:00"
  },
  "forcetime" : 1629287406992,
  "id" : "target1",
  "type" : "timeforced"
}, {
  "maintenanceWindow" : {
    "duration" : "00:10:00",
    "schedule" : "7 30 13 18 8 ? 2021",
    "timezone" : "+00:00"
  },
  "forcetime" : 1629287406992,
  "id" : "target2",
  "type" : "timeforced"
}, {
  "maintenanceWindow" : {
    "duration" : "00:10:00",
    "schedule" : "7 30 13 18 8 ? 2021",
    "timezone" : "+00:00"
  },
  "forcetime" : 1629287406992,
  "id" : "target3",
  "type" : "timeforced"
}, {
  "maintenanceWindow" : {
    "duration" : "00:10:00",
    "schedule" : "7 30 13 18 8 ? 2021",
    "timezone" : "+00:00"
  },
  "forcetime" : 1629287406992,
  "id" : "target4",
  "type" : "timeforced"
}, {
  "maintenanceWindow" : {
    "duration" : "00:10:00",
    "schedule" : "7 30 13 18 8 ? 2021",
    "timezone" : "+00:00"
  },
  "forcetime" : 1629287406992,
  "id" : "target5",
  "type" : "timeforced"
} ]'

Request URL

POST /rest/v1/distributionsets/16/assignedTargets HTTP/1.1
Content-Type: application/json
Content-Length: 1032
Host: management-api.host.com

[ {
  "maintenanceWindow" : {
    "duration" : "00:10:00",
    "schedule" : "6 30 13 18 8 ? 2021",
    "timezone" : "+00:00"
  },
  "forcetime" : 1629287406992,
  "id" : "target1",
  "type" : "timeforced"
}, {
  "maintenanceWindow" : {
    "duration" : "00:10:00",
    "schedule" : "7 30 13 18 8 ? 2021",
    "timezone" : "+00:00"
  },
  "forcetime" : 1629287406992,
  "id" : "target2",
  "type" : "timeforced"
}, {
  "maintenanceWindow" : {
    "duration" : "00:10:00",
    "schedule" : "7 30 13 18 8 ? 2021",
    "timezone" : "+00:00"
  },
  "forcetime" : 1629287406992,
  "id" : "target3",
  "type" : "timeforced"
}, {
  "maintenanceWindow" : {
    "duration" : "00:10:00",
    "schedule" : "7 30 13 18 8 ? 2021",
    "timezone" : "+00:00"
  },
  "forcetime" : 1629287406992,
  "id" : "target4",
  "type" : "timeforced"
}, {
  "maintenanceWindow" : {
    "duration" : "00:10:00",
    "schedule" : "7 30 13 18 8 ? 2021",
    "timezone" : "+00:00"
  },
  "forcetime" : 1629287406992,
  "id" : "target5",
  "type" : "timeforced"
} ]

Request path parameter

Parameter Description

distributionSetId

The technical identifier of the entity

Request query parameter

Parameter Description

offline

Offline update (set param to true) that is only reported but not managed by the service, e.g. defaults set in factory, manual updates or migrations from other update systems. A completed action is added to the history of the target(s). Target is set to IN_SYNC state as both assigend and installed DS are set. Note: only executed if the target has currently no running update.

Request fields

Path Type Description Allowed Values Mandatory

[].id

String

The technical identifier of the entity

X

[].weight

Number

Importance of the assignment.

0 - 1000

when multi-assignment is enabled

[].forcetime

Number

Forcetime in milliseconds.

[].maintenanceWindow

Object

Separation of download and install by defining a maintenance window for the installation.

[].maintenanceWindow.schedule

String

Schedule for the maintenance window start in quartz cron notation, such as '0 15 10 * * ? 2018' for 10:15am every day during the year 2018.

[].maintenanceWindow.duration

String

Duration of the window, such as '02:00:00' for 2 hours.

[].maintenanceWindow.timezone

String

A time-zone offset from Greenwich/UTC, such as '+02:00'.

[].type

String

The type of the assignment.

['soft', 'forced','timeforced', 'downloadonly']

Response (Status 200)

Response fields

Path Type Description Allowed Values

assigned

Number

Targets that now have this distribution set assigned.

alreadyAssigned

Number

Targets that had this distribution set already assigned (in "offline" case this includes targets that have arbitrary updates running)

assignedActions

Array

The newly created actions as a result of this assignment

assignedActions.[].id

Number

ID of the action.

assignedActions.[]._links.self

Object

The link to the action.

total

Number

Overall assigned as part of this request.

Response example

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

{
  "alreadyAssigned" : 1,
  "assignedActions" : [ {
    "_links" : {
      "self" : {
        "href" : "https://management-api.host.com/rest/v1/targets/target2/actions/16"
      }
    },
    "id" : 16
  }, {
    "_links" : {
      "self" : {
        "href" : "https://management-api.host.com/rest/v1/targets/target3/actions/13"
      }
    },
    "id" : 13
  }, {
    "_links" : {
      "self" : {
        "href" : "https://management-api.host.com/rest/v1/targets/target4/actions/15"
      }
    },
    "id" : 15
  }, {
    "_links" : {
      "self" : {
        "href" : "https://management-api.host.com/rest/v1/targets/target5/actions/14"
      }
    },
    "id" : 14
  } ],
  "total" : 5,
  "assigned" : 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

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/distributionsets/{distributionSetId}/installedTargets

Implementation Notes

Handles the GET request for retrieving installed targets of a single distribution set. Required permissions: READ_REPOSITORY and READ_TARGET

Get installed targets

Curl

$ curl 'https://management-api.host.com/rest/v1/distributionsets/18/installedTargets' -i -X GET \
    -H 'Accept: application/json'

Request URL

GET /rest/v1/distributionsets/18/installedTargets HTTP/1.1
Accept: application/json
Host: management-api.host.com

Request path parameter

Parameter Description

distributionSetId

The technical identifier of the entity

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/distributionsets/2/installedTargets?offset=1&limit=2&sort=name%3ADESC&q=controllerId%3D%3Dtarget* HTTP/1.1
Accept: application/json
Host: management-api.host.com

Response (Status 200)

Response fields

Path Type Description Allowed Values

total

Number

Total number of elements

size

Number

Current page size

content

Array[Object]

List of provisioning targets.

Response example

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 536

{
  "content" : [ {
    "createdBy" : "bumlux",
    "createdAt" : 1629287407519,
    "lastModifiedBy" : "bumlux",
    "lastModifiedAt" : 1629287407559,
    "name" : "targetExist",
    "controllerId" : "targetExist",
    "updateStatus" : "in_sync",
    "installedAt" : 1629287407551,
    "securityToken" : "3c88e1b59811c6b337c972e665096212",
    "requestAttributes" : true,
    "_links" : {
      "self" : {
        "href" : "https://management-api.host.com/rest/v1/targets/targetExist"
      }
    }
  } ],
  "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/distributionsets/{distributionSetId}/autoAssignTargetFilters

Implementation Notes

Handles the GET request for retrieving assigned target filter queries of a single distribution set. Required permissions: READ_REPOSITORY and READ_TARGET

Get installed targets

Curl

$ curl 'https://management-api.host.com/rest/v1/distributionsets/15/autoAssignTargetFilters' -i -X GET \
    -H 'Accept: application/json'

Request URL

GET /rest/v1/distributionsets/15/autoAssignTargetFilters HTTP/1.1
Accept: application/json
Host: management-api.host.com

Request path parameter

Parameter Description

distributionSetId

The technical identifier of the entity

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/distributionsets/1/autoAssignTargetFilters?offset=1&limit=2&sort=name%3ADESC&q=name%3D%3D*1 HTTP/1.1
Accept: application/json
Host: management-api.host.com

Response (Status 200)

Response fields

Path Type Description Allowed Values

total

Number

Total number of elements

size

Number

Current page size

content

Array[Object]

List of target filter queries.

Response example

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 907

{
  "content" : [ {
    "createdBy" : "bumlux",
    "createdAt" : 1629287406780,
    "lastModifiedBy" : "bumlux",
    "lastModifiedAt" : 1629287406780,
    "name" : "filter1",
    "query" : "name==a",
    "autoAssignDistributionSet" : 15,
    "autoAssignActionType" : null,
    "autoAssignWeight" : null,
    "_links" : {
      "self" : {
        "href" : "https://management-api.host.com/rest/v1/targetfilters/2"
      }
    },
    "id" : 2
  }, {
    "createdBy" : "bumlux",
    "createdAt" : 1629287406791,
    "lastModifiedBy" : "bumlux",
    "lastModifiedAt" : 1629287406791,
    "name" : "filter2",
    "query" : "name==b",
    "autoAssignDistributionSet" : 15,
    "autoAssignActionType" : null,
    "autoAssignWeight" : null,
    "_links" : {
      "self" : {
        "href" : "https://management-api.host.com/rest/v1/targetfilters/3"
      }
    },
    "id" : 3
  } ],
  "total" : 2,
  "size" : 2
}

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/distributionsets/{distributionSetId}/metadata

Implementation Notes

Get a paged list of meta data for a distribution set. Required permission: READ_REPOSITORY

Get a paged list of meta data

Curl

$ curl 'https://management-api.host.com/rest/v1/distributionsets/22/metadata' -i -X GET

Request URL

GET /rest/v1/distributionsets/22/metadata HTTP/1.1
Host: management-api.host.com

Request path parameter

Parameter Description

distributionSetId

The technical identifier of the entity

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/distributionsets/21/metadata?offset=1&limit=2&sort=key%3ADESC&q=key%3D%3Dknown* HTTP/1.1
Host: management-api.host.com

Response (Status 200)

Response fields

Path Type Description Allowed Values

total

Number

Total number of elements

size

Number

Current page size

content

Array

List of metadata.

content[].key

String

Metadata property key.

content[].value

String

Metadata property value.

Response example

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

{
  "content" : [ {
    "key" : "knownKey0",
    "value" : "knownValue0"
  }, {
    "key" : "knownKey1",
    "value" : "knownValue1"
  }, {
    "key" : "knownKey2",
    "value" : "knownValue2"
  }, {
    "key" : "knownKey3",
    "value" : "knownValue3"
  } ],
  "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/distributionsets/{distributionSetId}/metadata

Implementation Notes

Create a list of meta data entries Required permissions: READ_REPOSITORY and UPDATE_TARGET

Create a list of meta data entries

CURL

$ curl 'https://management-api.host.com/rest/v1/distributionsets/14/metadata' -i -X POST \
    -H 'Content-Type: application/json' \
    -d '[ {
  "value" : "knownValue1",
  "key" : "knownKey1"
}, {
  "value" : "knownValue2",
  "key" : "knownKey2"
} ]'

Request URL

POST /rest/v1/distributionsets/14/metadata HTTP/1.1
Content-Type: application/json
Content-Length: 110
Host: management-api.host.com

[ {
  "value" : "knownValue1",
  "key" : "knownKey1"
}, {
  "value" : "knownValue2",
  "key" : "knownKey2"
} ]

Request path parameter

Parameter Description

distributionSetId

The technical identifier of the entity

Request fields

Path Type Description Allowed Values Mandatory

[]key

String

Metadata property key.

X

[]value

String

Metadata property value.

Response (Status 200)

Response example

HTTP/1.1 201 Created
Content-Type: application/hal+json
Content-Length: 110

[ {
  "key" : "knownKey1",
  "value" : "knownValue1"
}, {
  "key" : "knownKey2",
  "value" : "knownValue2"
} ]

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/distributionsets/{distributionSetId}/metadata/{metadataKey}

Implementation Notes

Delete a single meta data. Required permission: UPDATE_REPOSITORY

Delete a single meta data

CURL

$ curl 'https://management-api.host.com/rest/v1/distributionsets/23/metadata/knownKey' -i -X DELETE

Request URL

DELETE /rest/v1/distributionsets/23/metadata/knownKey HTTP/1.1
Host: management-api.host.com

Request path parameter

Parameter Description

distributionSetId

The technical identifier of the entity

key

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

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.

GET /rest/v1/distributionsets/{distributionSetId}/metadata/{metadataKey}

Implementation Notes

Get a single meta data value for a meta data key. Required permission: READ_REPOSITORY

Get a single meta data value

Curl

$ curl 'https://management-api.host.com/rest/v1/distributionsets/20/metadata/knownKey' -i -X GET

Request URL

GET /rest/v1/distributionsets/20/metadata/knownKey HTTP/1.1
Host: management-api.host.com

Request path parameter

Parameter Description

distributionSetId

The technical identifier of the entity

metadatakey

The technical identifier of the entity

Response (Status 200)

Response fields

Path Type Description Allowed Values

key

String

Metadata property key.

value

String

Metadata property value.

Response example

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 50

{
  "key" : "knownKey",
  "value" : "knownValue"
}

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.

PUT /rest/v1/distributionsets/{distributionSetId}/metadata/{metadataKey}

Implementation Notes

Update a single meta data value for speficic key. Required permission: UPDATE_REPOSITORY

Update a single meta data value

Curl

$ curl 'https://management-api.host.com/rest/v1/distributionsets/13/metadata/knownKey' -i -X PUT \
    -H 'Content-Type: application/json' \
    -d '{
  "value" : "valueForUpdate",
  "key" : "knownKey"
}'

Request URL

PUT /rest/v1/distributionsets/13/metadata/knownKey HTTP/1.1
Content-Type: application/json
Content-Length: 54
Host: management-api.host.com

{
  "value" : "valueForUpdate",
  "key" : "knownKey"
}

Request path parameter

Parameter Description

distributionSetId

The technical identifier of the entity

metadatakey

The technical identifier of the entity

Request fields

Path Type Description Allowed Values Mandatory

key

String

Metadata property key.

X

value

String

Metadata property value.

X

Response (Status 200)

Response fields

Path Type Description Allowed Values

key

String

Metadata property key.

value

String

Metadata property value.

Response example

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

{
  "key" : "knownKey",
  "value" : "valueForUpdate"
}

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.

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