hawkBit rest docs (management & DDI API) (#688)
* hawkBit REST docs. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Fiy gitignore. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Add to website. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Switch to generated docs. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Fix typos. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Review findings. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Otimizations. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Revert accidental checkin. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Add security link.
This commit is contained in:
Kai Zimmermann
@@ -0,0 +1,840 @@
|
||||
:doctype: book
|
||||
:icons: font
|
||||
:source-highlighter: highlightjs
|
||||
:toc: macro
|
||||
:toclevels: 1
|
||||
:sectlinks:
|
||||
:linkattrs:
|
||||
|
||||
[[distributionsets]]
|
||||
= Distributionsets
|
||||
|
||||
toc::[]
|
||||
|
||||
== 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
|
||||
|
||||
include::{snippets}/distributionsets/get-distribution-sets/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/distributionsets/get-distribution-sets/http-request.adoc[]
|
||||
|
||||
==== Request query parameter
|
||||
|
||||
include::{snippets}/distributionsets/get-distribution-sets-with-parameters/request-parameters.adoc[]
|
||||
|
||||
==== Request query parameter example
|
||||
|
||||
include::{snippets}/distributionsets/get-distribution-sets-with-parameters/http-request.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/distributionsets/get-distribution-sets/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/distributionsets/get-distribution-sets/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== 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
|
||||
|
||||
include::{snippets}/distributionsets/create-distribution-sets/curl-request.adoc[]
|
||||
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/distributionsets/create-distribution-sets/http-request.adoc[]
|
||||
|
||||
==== Request fields
|
||||
|
||||
include::{snippets}/distributionsets/create-distribution-sets/request-fields.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/distributionsets/create-distribution-sets/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/distributionsets/create-distribution-sets/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/409.adoc[]
|
||||
include::../errors/415.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== 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
|
||||
|
||||
include::{snippets}/distributionsets/delete-distribution-set/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/distributionsets/delete-distribution-set/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/distributionsets/delete-distribution-set/path-parameters.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/distributionsets/delete-distribution-set/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/404.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
== 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
|
||||
|
||||
include::{snippets}/distributionsets/get-distribution-set/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/distributionsets/get-distribution-set/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/distributionsets/get-distribution-set/path-parameters.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/distributionsets/get-distribution-set/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/distributionsets/get-distribution-set/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/404.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== 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
|
||||
|
||||
include::{snippets}/distributionsets/update-distribution-set/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/distributionsets/update-distribution-set/http-request.adoc[]
|
||||
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/distributionsets/update-distribution-set/path-parameters.adoc[]
|
||||
|
||||
==== Request fields
|
||||
|
||||
include::{snippets}/distributionsets/update-distribution-set/request-fields.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/distributionsets/update-distribution-set/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/distributionsets/update-distribution-set/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/404.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/409.adoc[]
|
||||
include::../errors/415.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
== 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
|
||||
|
||||
include::{snippets}/distributionsets/get-assigned-software-modules/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/distributionsets/get-assigned-software-modules/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/distributionsets/get-assigned-software-modules/path-parameters.adoc[]
|
||||
|
||||
==== Request query parameter
|
||||
|
||||
include::{snippets}/distributionsets/get-assigned-software-modules-with-parameters/request-parameters.adoc[]
|
||||
|
||||
==== Request parameter example
|
||||
|
||||
include::{snippets}/distributionsets/get-assigned-software-modules-with-parameters/http-request.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/distributionsets/get-assigned-software-modules/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/distributionsets/get-assigned-software-modules/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== 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
|
||||
|
||||
include::{snippets}/distributionsets/assign-software-modules/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/distributionsets/assign-software-modules/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/distributionsets/assign-software-modules/path-parameters.adoc[]
|
||||
|
||||
==== Request fields
|
||||
|
||||
include::{snippets}/distributionsets/assign-software-modules/request-fields.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/distributionsets/assign-software-modules/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/404.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/409.adoc[]
|
||||
include::../errors/415.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
== DELETE /rest/v1/distributionsets/{distributionSetId}/assignedSM/{softwareModuleId}
|
||||
|
||||
|
||||
=== Implementation Notes
|
||||
|
||||
Delete a assignment. Required permission: UPDATE_REPOSITORY
|
||||
|
||||
=== Delete assignment of Software Module
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/distributionsets/delete-assign-software-modules/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/distributionsets/delete-assign-software-modules/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/distributionsets/delete-assign-software-modules/path-parameters.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/distributionsets/delete-assign-software-modules/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/404.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== 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
|
||||
|
||||
include::{snippets}/distributionsets/get-assigned-targets/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/distributionsets/get-assigned-targets/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/distributionsets/get-assigned-targets/path-parameters.adoc[]
|
||||
|
||||
==== Request query parameter
|
||||
|
||||
include::{snippets}/distributionsets/get-assigned-targets-with-parameters/request-parameters.adoc[]
|
||||
|
||||
==== Request parameter example
|
||||
|
||||
include::{snippets}/distributionsets/get-assigned-targets-with-parameters/http-request.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/distributionsets/get-assigned-targets/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/distributionsets/get-assigned-targets/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== 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
|
||||
|
||||
include::{snippets}/distributionsets/create-assigned-target/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/distributionsets/create-assigned-target/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/distributionsets/create-assigned-target/path-parameters.adoc[]
|
||||
|
||||
==== Request query parameter
|
||||
|
||||
include::{snippets}/distributionsets/create-assigned-target/request-parameters.adoc[]
|
||||
|
||||
==== Request fields
|
||||
|
||||
include::{snippets}/distributionsets/create-assigned-target/request-fields.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/distributionsets/create-assigned-target/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/distributionsets/create-assigned-target/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/404.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/409.adoc[]
|
||||
include::../errors/415.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
== 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
|
||||
|
||||
include::{snippets}/distributionsets/get-installed-targets/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/distributionsets/get-installed-targets/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/distributionsets/get-installed-targets/path-parameters.adoc[]
|
||||
|
||||
==== Request query parameter
|
||||
|
||||
include::{snippets}/distributionsets/get-installed-targets-with-parameters/request-parameters.adoc[]
|
||||
|
||||
==== Request parameter example
|
||||
|
||||
include::{snippets}/distributionsets/get-installed-targets-with-parameters/http-request.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/distributionsets/get-installed-targets/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/distributionsets/get-installed-targets/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== 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
|
||||
|
||||
include::{snippets}/distributionsets/get-auto-assign-target-filter-queries/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/distributionsets/get-auto-assign-target-filter-queries/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/distributionsets/get-auto-assign-target-filter-queries/path-parameters.adoc[]
|
||||
|
||||
==== Request query parameter
|
||||
|
||||
include::{snippets}/distributionsets/get-auto-assign-target-filter-queries-with-parameters/request-parameters.adoc[]
|
||||
|
||||
==== Request parameter example
|
||||
|
||||
include::{snippets}/distributionsets/get-auto-assign-target-filter-queries-with-parameters/http-request.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/distributionsets/get-auto-assign-target-filter-queries/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/distributionsets/get-auto-assign-target-filter-queries/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== 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
|
||||
|
||||
include::{snippets}/distributionsets/get-metadata/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/distributionsets/get-metadata/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/distributionsets/get-metadata/path-parameters.adoc[]
|
||||
|
||||
==== Request query parameter
|
||||
|
||||
include::{snippets}/distributionsets/get-metadata-with-parameters/request-parameters.adoc[]
|
||||
|
||||
==== Request parameter example
|
||||
|
||||
include::{snippets}/distributionsets/get-metadata-with-parameters/http-request.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/distributionsets/get-metadata/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/distributionsets/get-metadata/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
== 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
|
||||
|
||||
include::{snippets}/distributionsets/create-metadata/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/distributionsets/create-metadata/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/distributionsets/create-metadata/path-parameters.adoc[]
|
||||
|
||||
==== Request fields
|
||||
|
||||
include::{snippets}/distributionsets/create-metadata/request-fields.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/distributionsets/create-metadata/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/404.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/409.adoc[]
|
||||
include::../errors/415.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== DELETE /rest/v1/distributionsets/{distributionSetId}/metadata/{metadataKey}
|
||||
|
||||
|
||||
=== Implementation Notes
|
||||
|
||||
Delete a single meta data. Required permission: UPDATE_REPOSITORY
|
||||
|
||||
=== Delete a single meta data
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/distributionsets/delete-metadata/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/distributionsets/delete-metadata/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/distributionsets/delete-metadata/path-parameters.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/distributionsets/delete-metadata/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/404.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== 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
|
||||
|
||||
include::{snippets}/distributionsets/get-metadata-value/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/distributionsets/get-metadata-value/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/distributionsets/get-metadata-value/path-parameters.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/distributionsets/get-metadata-value/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/distributionsets/get-metadata-value/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
== 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
|
||||
|
||||
include::{snippets}/distributionsets/update-metadata/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/distributionsets/update-metadata/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/distributionsets/update-metadata/path-parameters.adoc[]
|
||||
|
||||
==== Request fields
|
||||
|
||||
include::{snippets}/distributionsets/update-metadata/request-fields.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/distributionsets/update-metadata/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/distributionsets/update-metadata/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/404.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/409.adoc[]
|
||||
include::../errors/415.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== Additional content
|
||||
|
||||
[[error-body]]
|
||||
=== Error body
|
||||
|
||||
include::../errors/error-response-body.adoc[]
|
||||
|
||||
@@ -0,0 +1,433 @@
|
||||
:doctype: book
|
||||
:icons: font
|
||||
:source-highlighter: highlightjs
|
||||
:toc: macro
|
||||
:toclevels: 1
|
||||
:sectlinks:
|
||||
:linkattrs:
|
||||
|
||||
[[distributionsettag]]
|
||||
= Distribution set Tag
|
||||
|
||||
toc::[]
|
||||
|
||||
|
||||
== GET /rest/v1/distributionsettags
|
||||
|
||||
=== Implementation notes
|
||||
|
||||
Handles the GET request of retrieving all distribution set tags.
|
||||
|
||||
=== Get paged list of distribution set tags
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/distributionsettag/get-distribution-set-tags/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
A `GET` request is used to access the distribution set tags
|
||||
|
||||
include::{snippets}/distributionsettag/get-distribution-set-tags/http-request.adoc[]
|
||||
|
||||
==== Request query parameter
|
||||
|
||||
include::{snippets}/distributionsettag/get-distribution-set-tags-with-parameters/request-parameters.adoc[]
|
||||
|
||||
==== Request parameter example
|
||||
|
||||
include::{snippets}/distributionsettag/get-distribution-set-tags-with-parameters/http-request.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/distributionsettag/get-distribution-set-tags/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/distributionsettag/get-distribution-set-tags/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== GET /rest/v1/distributionsettags/{distributionsetTagId}
|
||||
|
||||
=== Implementation notes
|
||||
|
||||
Handles the GET request of retrieving a single distribution set tag.
|
||||
|
||||
=== Get a single distribution set tag
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/distributionsettag/get-distribution-set-tag/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
A `GET` request is used to access the distribution set tag
|
||||
|
||||
include::{snippets}/distributionsettag/get-distribution-set-tag/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/distributionsettag/get-distribution-set-tag/path-parameters.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/distributionsettag/get-distribution-set-tag/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/distributionsettag/get-distribution-set-tag/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== POST /rest/v1/distributionsettags
|
||||
|
||||
=== Implementation Notes
|
||||
|
||||
Handles the POST request of creating new distribution set tag. The request body must always be a list of distribution set tags.
|
||||
|
||||
=== Create list of distribution set tags
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/distributionsettag/create-distribution-set-tags/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/distributionsettag/create-distribution-set-tags/http-request.adoc[]
|
||||
|
||||
==== Request fields
|
||||
|
||||
include::{snippets}/distributionsettag/create-distribution-set-tags/request-fields.adoc[]
|
||||
|
||||
=== Response (Status 201)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/distributionsettag/create-distribution-set-tags/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/distributionsettag/create-distribution-set-tags/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/409.adoc[]
|
||||
include::../errors/415.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
== PUT /rest/v1/distributionsettags/{distributionsetTagId}
|
||||
|
||||
=== Implementation Notes
|
||||
|
||||
Handles the PUT request of updating a distribution set tag.
|
||||
|
||||
=== Update a distribution set tag
|
||||
|
||||
==== Curl
|
||||
|
||||
include::{snippets}/distributionsettag/update-distribution-set-tag/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/distributionsettag/update-distribution-set-tag/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/distributionsettag/update-distribution-set-tag/path-parameters.adoc[]
|
||||
|
||||
==== Request fields
|
||||
|
||||
include::{snippets}/distributionsettag/update-distribution-set-tag/request-fields.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/distributionsettag/update-distribution-set-tag/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/distributionsettag/update-distribution-set-tag/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/404.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/409.adoc[]
|
||||
include::../errors/415.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== DELETE /rest/v1/distributionsettags/{distributionsetTagId}
|
||||
|
||||
=== Implementation Notes
|
||||
|
||||
Handles the DELETE request of deleting a single distribution set tag.
|
||||
|
||||
=== Deleting a distribution set tag
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/distributionsettag/delete-distribution-set-tag/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/distributionsettag/delete-distribution-set-tag/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/distributionsettag/delete-distribution-set-tag/path-parameters.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/distributionsettag/delete-distribution-set-tag/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/404.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/409.adoc[]
|
||||
include::../errors/415.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== GET /rest/v1/distributionsettags/{distributionsetTagId}/distributionsets
|
||||
|
||||
=== Implementation Notes
|
||||
|
||||
Handles the GET request of retrieving a list of assigned distributions.
|
||||
|
||||
=== Get a list of assigned distributions
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/distributionsettag/get-assigned-distribution-sets/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/distributionsettag/get-assigned-distribution-sets/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/distributionsettag/get-assigned-distribution-sets/path-parameters.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/distributionsettag/get-assigned-distribution-sets/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/distributionsettag/get-assigned-distribution-sets/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/404.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== POST /rest/v1/distributionsettags/{distributionsetTagId}/distributionsets/toggleTagAssignment
|
||||
|
||||
=== Implementation Notes
|
||||
|
||||
Handles the POST request of toogle distribution assignment. The request body must always be a list of controller ids.
|
||||
|
||||
=== Toogle distribution assignment
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/distributionsettag/toggle-tag-assignment/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/distributionsettag/toggle-tag-assignment/http-request.adoc[]
|
||||
|
||||
==== Request fields
|
||||
|
||||
include::{snippets}/distributionsettag/toggle-tag-assignment/request-fields.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/distributionsettag/toggle-tag-assignment/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/distributionsettag/toggle-tag-assignment/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/409.adoc[]
|
||||
include::../errors/415.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
== POST /rest/v1/distributionsettags/{distributionsetTagId}/distributionsets
|
||||
|
||||
=== Implementation Notes
|
||||
|
||||
Handles the POST request of distribution assignment. Already assigned distribution will be ignored.
|
||||
|
||||
=== Distribution assignment
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/distributionsettag/assign-distribution-sets/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/distributionsettag/assign-distribution-sets/http-request.adoc[]
|
||||
|
||||
==== Request fields
|
||||
|
||||
include::{snippets}/distributionsettag/assign-distribution-sets/request-fields.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/distributionsettag/assign-distribution-sets/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/distributionsettag/assign-distribution-sets/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/409.adoc[]
|
||||
include::../errors/415.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
== DELETE /rest/v1/distributionsettags/{distributionsetTagId}/distributionsets/{distributionsetId}
|
||||
|
||||
=== Implementation Notes
|
||||
|
||||
Handles the DELETE request of unassign the given distribution.
|
||||
|
||||
=== Unassign a distribution
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/distributionsettag/unassign-distribution-set/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/distributionsettag/unassign-distribution-set/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/distributionsettag/unassign-distribution-set/path-parameters.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/distributionsettag/unassign-distribution-set/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/404.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
== Additional content
|
||||
|
||||
[[error-body]]
|
||||
=== Error body
|
||||
|
||||
include::../errors/error-response-body.adoc[]
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,638 @@
|
||||
:doctype: book
|
||||
:icons: font
|
||||
:source-highlighter: highlightjs
|
||||
:toc: macro
|
||||
:toclevels: 1
|
||||
:sectlinks:
|
||||
:linkattrs:
|
||||
|
||||
[[distributionset-types]]
|
||||
= Distribution Set Types
|
||||
|
||||
toc::[]
|
||||
|
||||
== 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
|
||||
|
||||
include::{snippets}/distributionsettypes/get-distribution-set-types/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/distributionsettypes/get-distribution-set-types/http-request.adoc[]
|
||||
|
||||
==== Request query parameter
|
||||
|
||||
include::{snippets}/distributionsettypes/get-distribution-set-types-with-parameters/request-parameters.adoc[]
|
||||
|
||||
==== Request parameter example
|
||||
|
||||
include::{snippets}/distributionsettypes/get-distribution-set-types-with-parameters/http-request.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/distributionsettypes/get-distribution-set-types/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/distributionsettypes/get-distribution-set-types/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== 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
|
||||
|
||||
include::{snippets}/distributionsettypes/post-distribution-set-types/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/distributionsettypes/post-distribution-set-types/http-request.adoc[]
|
||||
|
||||
==== Request fields
|
||||
|
||||
include::{snippets}/distributionsettypes/post-distribution-set-types/request-fields.adoc[]
|
||||
|
||||
=== Response (Status 201)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/distributionsettypes/post-distribution-set-types/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/distributionsettypes/post-distribution-set-types/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
| `404 Not Found`
|
||||
| Distribution set type was not found.
|
||||
| See <<error-body>>
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
| `409 Conflict`
|
||||
| Distribution set type already exists
|
||||
| See <<error-body>>
|
||||
include::../errors/415.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== 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
|
||||
|
||||
include::{snippets}/distributionsettypes/delete-distribution-set-type/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/distributionsettypes/delete-distribution-set-type/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/distributionsettypes/delete-distribution-set-type/path-parameters.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/distributionsettypes/delete-distribution-set-type/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
| `404 Not Found`
|
||||
| Distribution set type was not found.
|
||||
| See <<error-body>>
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== 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
|
||||
|
||||
include::{snippets}/distributionsettypes/get-distribution-set-type/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/distributionsettypes/get-distribution-set-type/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/distributionsettypes/get-distribution-set-type/path-parameters.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/distributionsettypes/get-distribution-set-type/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/distributionsettypes/get-distribution-set-type/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
| `404 Not Found`
|
||||
| Distribution set type was not found.
|
||||
| See <<error-body>>
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
== 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
|
||||
|
||||
include::{snippets}/distributionsettypes/put-distribution-set-type/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/distributionsettypes/put-distribution-set-type/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/distributionsettypes/put-distribution-set-type/path-parameters.adoc[]
|
||||
|
||||
==== Request fields
|
||||
|
||||
include::{snippets}/distributionsettypes/put-distribution-set-type/request-fields.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/distributionsettypes/put-distribution-set-type/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/distributionsettypes/put-distribution-set-type/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
| `404 Not Found`
|
||||
| Distribution set type was not found.
|
||||
| See <<error-body>>
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/409.adoc[]
|
||||
include::../errors/415.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== 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
|
||||
|
||||
include::{snippets}/distributionsettypes/get-mandatory-modules/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/distributionsettypes/get-mandatory-modules/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/distributionsettypes/get-mandatory-modules/path-parameters.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/distributionsettypes/get-mandatory-modules/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/distributionsettypes/get-mandatory-modules/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
| `404 Not Found`
|
||||
| Distribution set type was not found.
|
||||
| See <<error-body>>
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== 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
|
||||
|
||||
include::{snippets}/distributionsettypes/post-mandatory-module/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/distributionsettypes/post-mandatory-module/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/distributionsettypes/post-mandatory-module/path-parameters.adoc[]
|
||||
|
||||
==== Request fields
|
||||
|
||||
include::{snippets}/distributionsettypes/post-mandatory-module/request-fields.adoc[]
|
||||
|
||||
=== Response (Status 201)
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/distributionsettypes/post-mandatory-module/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
| `404 Not Found`
|
||||
| Distribution set type was not found.
|
||||
| See <<error-body>>
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
| `409 Conflict`
|
||||
| Distribution set type already exists
|
||||
| See <<error-body>>
|
||||
include::../errors/415.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== 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
|
||||
|
||||
include::{snippets}/distributionsettypes/delete-mandatory-module/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/distributionsettypes/delete-mandatory-module/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/distributionsettypes/delete-mandatory-module/path-parameters.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/distributionsettypes/delete-mandatory-module/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
| `404 Not Found`
|
||||
| Distribution set type was not found.
|
||||
| See <<error-body>>
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== 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
|
||||
|
||||
include::{snippets}/distributionsettypes/get-mandatory-module/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/distributionsettypes/get-mandatory-module/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/distributionsettypes/get-mandatory-module/path-parameters.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/distributionsettypes/get-mandatory-module/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/distributionsettypes/get-mandatory-module/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
| `404 Not Found`
|
||||
| Distribution set type was not found.
|
||||
| See <<error-body>>
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== 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
|
||||
|
||||
include::{snippets}/distributionsettypes/get-optional-modules/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/distributionsettypes/get-optional-modules/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/distributionsettypes/get-optional-modules/path-parameters.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/distributionsettypes/get-optional-modules/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/distributionsettypes/get-optional-modules/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
| `404 Not Found`
|
||||
| Distribution set type was not found.
|
||||
| See <<error-body>>
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
== 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
|
||||
|
||||
include::{snippets}/distributionsettypes/post-optional-module/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/distributionsettypes/post-optional-module/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/distributionsettypes/post-optional-module/path-parameters.adoc[]
|
||||
|
||||
==== Request fields
|
||||
|
||||
include::{snippets}/distributionsettypes/post-optional-module/request-fields.adoc[]
|
||||
|
||||
=== Response (Status 201)
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/distributionsettypes/post-optional-module/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
| `404 Not Found`
|
||||
| Distribution set type was not found.
|
||||
| See <<error-body>>
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
| `409 Conflict`
|
||||
| Distribution set type already exists
|
||||
| See <<error-body>>
|
||||
include::../errors/415.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== 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
|
||||
|
||||
include::{snippets}/distributionsettypes/delete-optional-module/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/distributionsettypes/delete-optional-module/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/distributionsettypes/delete-optional-module/path-parameters.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/distributionsettypes/delete-optional-module/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
| `404 Not Found`
|
||||
| Distribution set type was not found.
|
||||
| See <<error-body>>
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== 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
|
||||
|
||||
include::{snippets}/distributionsettypes/get-optional-module/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/distributionsettypes/get-optional-module/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/distributionsettypes/post-optional-module/path-parameters.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/distributionsettypes/get-optional-module/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/distributionsettypes/get-optional-module/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
| `404 Not Found`
|
||||
| Distribution set type was not found.
|
||||
| See <<error-body>>
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
== Additional content
|
||||
|
||||
[[error-body]]
|
||||
=== Error body
|
||||
|
||||
include::../errors/error-response-body.adoc[]
|
||||
@@ -0,0 +1,477 @@
|
||||
:doctype: book
|
||||
:icons: font
|
||||
:source-highlighter: highlightjs
|
||||
:toc: macro
|
||||
:toclevels: 1
|
||||
:sectlinks:
|
||||
:linkattrs:
|
||||
|
||||
|
||||
|
||||
[[rollouts]]
|
||||
= Rollouts
|
||||
|
||||
toc::[]
|
||||
|
||||
|
||||
== GET /rest/v1/rollouts
|
||||
|
||||
=== Implementation notes
|
||||
|
||||
Handles the GET request of retrieving all rollouts within SP. Required Permission: READ_ROLLOUT
|
||||
|
||||
=== Get paged list of Rollouts
|
||||
|
||||
==== Curl
|
||||
|
||||
include::{snippets}/rollouts/get-rollouts/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/rollouts/get-rollouts/http-request.adoc[]
|
||||
|
||||
==== Request query parameter
|
||||
|
||||
include::{snippets}/rollouts/get-rollouts-with-parameters/request-parameters.adoc[]
|
||||
|
||||
==== Request query parameter example
|
||||
|
||||
include::{snippets}/rollouts/get-rollouts-with-parameters/http-request.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/rollouts/get-rollouts/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/rollouts/get-rollouts/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
== GET /rest/v1/rollouts/{rolloutId}
|
||||
|
||||
=== Implementation Notes
|
||||
|
||||
Handles the GET request of retrieving a single rollout within SP. Required Permission: READ_ROLLOUT
|
||||
|
||||
=== Get Rollout
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/rollouts/get-rollout/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/rollouts/get-rollout/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/rollouts/get-rollout/path-parameters.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/rollouts/get-rollout/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/rollouts/get-rollout/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/404.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
== POST /rest/v1/rollouts
|
||||
|
||||
=== Implementation Notes
|
||||
Handles the POST request of creating new rollout within SP. Required Permission: CREATE_ROLLOUT
|
||||
|
||||
=== Create Rollout with defined amount of groups
|
||||
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/rollouts/create-rollout/curl-request.adoc[]
|
||||
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/rollouts/create-rollout/http-request.adoc[]
|
||||
|
||||
==== Request fields
|
||||
|
||||
include::{snippets}/rollouts/create-rollout/request-fields.adoc[]
|
||||
|
||||
=== Response (Status 201)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/rollouts/create-rollout/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/rollouts/create-rollout/http-response.adoc[]
|
||||
|
||||
|
||||
=== Create Rollout with groups definition
|
||||
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/rollouts/create-rollout-with-groups-definition/curl-request.adoc[]
|
||||
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/rollouts/create-rollout-with-groups-definition/http-request.adoc[]
|
||||
|
||||
==== Request fields
|
||||
|
||||
include::{snippets}/rollouts/create-rollout-with-groups-definition/request-fields.adoc[]
|
||||
|
||||
=== Response (Status 201)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/rollouts/create-rollout-with-groups-definition/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/rollouts/create-rollout-with-groups-definition/http-response.adoc[]
|
||||
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/409.adoc[]
|
||||
include::../errors/415.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
== POST /rest/v1/rollouts/{rolloutId}/start
|
||||
|
||||
=== Implementation Notes
|
||||
Handles the POST request of starting a created rollout within SP. Required Permission: HANDLE_ROLLOUT
|
||||
|
||||
=== Start Rollout
|
||||
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/rollouts/start-rollout/curl-request.adoc[]
|
||||
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/rollouts/start-rollout/http-request.adoc[]
|
||||
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/rollouts/start-rollout/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
== POST /rest/v1/rollouts/{rolloutId}/pause
|
||||
|
||||
=== Implementation Notes
|
||||
Handles the POST request of pausing a running rollout within SP. Required Permission: HANDLE_ROLLOUT
|
||||
|
||||
=== Pause Rollout
|
||||
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/rollouts/pause-rollout/curl-request.adoc[]
|
||||
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/rollouts/pause-rollout/http-request.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/rollouts/pause-rollout/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
== POST /rest/v1/rollouts/{rolloutId}/resume
|
||||
|
||||
=== Implementation Notes
|
||||
Handles the POST request of resuming a paused rollout within SP. Required Permission: HANDLE_ROLLOUT
|
||||
|
||||
=== Resume Rollout
|
||||
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/rollouts/resume-rollout/curl-request.adoc[]
|
||||
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/rollouts/resume-rollout/http-request.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/rollouts/resume-rollout/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
== DELETE /rest/v1/rollouts/{rolloutId}
|
||||
|
||||
=== Implementation Notes
|
||||
|
||||
Handles the DELETE request of deleting a rollout within SP. Required Permission: DELETE_ROLLOUT
|
||||
|
||||
=== Deleting a rollout
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/rollouts/delete-rollout/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/rollouts/delete-rollout/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/rollouts/delete-rollout/path-parameters.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/rollouts/delete-rollout/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/404.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
== GET /rest/v1/rollouts/{rolloutId}/deploygroups
|
||||
|
||||
=== Implementation Notes
|
||||
|
||||
Handles the GET request of retrieving all deploy groups of a specific rollout within SP. Required Permission: READ_ROLLOUT
|
||||
|
||||
=== Get Deploy Groups
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/rollouts/get-rollout-deploy-groups/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/rollouts/get-rollout-deploy-groups/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/rollouts/get-rollout-deploy-groups/path-parameters.adoc[]
|
||||
|
||||
==== Request query parameter
|
||||
|
||||
include::{snippets}/rollouts/get-rollouts-with-parameters/request-parameters.adoc[]
|
||||
|
||||
==== Request query parameter example
|
||||
|
||||
include::{snippets}/rollouts/get-rollouts-with-parameters/http-request.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/rollouts/get-rollout-deploy-groups/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/rollouts/get-rollout-deploy-groups/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/404.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
== GET /rest/v1/rollouts/{rolloutId}/deploygroups/{deployGroupId}
|
||||
|
||||
=== Implementation Notes
|
||||
|
||||
Handles the GET request of a single deploy group of a specific rollout within SP. Required Permission: READ_ROLLOUT
|
||||
|
||||
=== Get Deploy Groups
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/rollouts/get-rollout-deploy-group/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/rollouts/get-rollout-deploy-group/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/rollouts/get-rollout-deploy-group/path-parameters.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/rollouts/get-rollout-deploy-group/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/rollouts/get-rollout-deploy-group/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/404.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
== GET /rest/v1/rollouts/{rolloutId}/deploygroups/{deployGroupId}/targets
|
||||
|
||||
=== Implementation Notes
|
||||
|
||||
Handles the GET request of retrieving all targets of a single deploy group of a specific rollout within SP. Required Permissions: READ_ROLLOUT, READ_TARGET.
|
||||
|
||||
=== Get Deploy Group Targets
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/rollouts/get-rollout-deploy-group-targets/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/rollouts/get-rollout-deploy-group-targets/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/rollouts/get-rollout-deploy-group-targets/path-parameters.adoc[]
|
||||
|
||||
==== Request query parameter
|
||||
|
||||
include::{snippets}/rollouts/get-rollout-deploy-group-targets-with-parameters/request-parameters.adoc[]
|
||||
|
||||
==== Request query parameter example
|
||||
|
||||
include::{snippets}/rollouts/get-rollout-deploy-group-targets-with-parameters/http-request.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/rollouts/get-rollout-deploy-group-targets/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/rollouts/get-rollout-deploy-group-targets/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/404.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
== Additional content
|
||||
|
||||
[[error-body]]
|
||||
=== Error body
|
||||
|
||||
include::../errors/error-response-body.adoc[]
|
||||
@@ -0,0 +1,398 @@
|
||||
:doctype: book
|
||||
:icons: font
|
||||
:source-highlighter: highlightjs
|
||||
:toc: macro
|
||||
:toclevels: 1
|
||||
:sectlinks:
|
||||
:linkattrs:
|
||||
|
||||
[[root-controller]]
|
||||
= Root Controller
|
||||
|
||||
toc::[]
|
||||
|
||||
== GET /{tenant}/controller/v1/{targetid}
|
||||
|
||||
=== Implementation notes
|
||||
|
||||
This base resource can be regularly polled by the controller on the provisioning target or device in order to retrieve actions that need to be executed. Those are provided as a list of links to more detailed information about the action. The resource supports Etag based modification checks in order to save traffic. Note: deployments have to be confirmed in order to move on to the next action. Cancellations have to be confirmed or rejected.
|
||||
|
||||
=== Controller base poll resource
|
||||
|
||||
==== Curl
|
||||
|
||||
include::{snippets}/rootcontroller/get-controller-base-with-open-deplyoment/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/rootcontroller/get-controller-base-with-open-deplyoment/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/rootcontroller/get-controller-base-with-open-deplyoment/path-parameters.adoc[]
|
||||
|
||||
=== Response (Status 200) with an active deployment
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/rootcontroller/get-controller-base-with-open-deplyoment/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/rootcontroller/get-controller-base-with-open-deplyoment/http-response.adoc[]
|
||||
|
||||
=== Response (Status 200) with an active cancellation
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/rootcontroller/get-controller-base-with-open-deployment-cancellation/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/rootcontroller/get-controller-base-with-open-deployment-cancellation/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403_quota.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== GET /{tenant}/controller/v1/{targetid}/cancelAction/{actionId}
|
||||
|
||||
=== Implementation notes
|
||||
|
||||
The SP server might cancel an operation, e.g. an unfinished update has a sucessor. It is up to the provisiong target to decide to accept the cancelation or reject it.
|
||||
|
||||
=== Cancel an action
|
||||
|
||||
==== Curl
|
||||
|
||||
include::{snippets}/rootcontroller/get-controller-cancel-action/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/rootcontroller/get-controller-cancel-action/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/rootcontroller/get-controller-cancel-action/path-parameters.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/rootcontroller/get-controller-cancel-action/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/rootcontroller/get-controller-cancel-action/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
|
||||
== POST /{tenant}/controller/v1/{targetid}/cancelAction/{actionId}/feedback
|
||||
|
||||
=== Implementation notes
|
||||
|
||||
It is up to the device how much intermediate feedback is provided. However, the action will be kept open until the controller on the device reports a finished (either successful or error) or rejects the action, e.g. the canceled actions have been started already.
|
||||
|
||||
=== Feedback channel for cancel actions
|
||||
|
||||
==== Curl
|
||||
|
||||
include::{snippets}/rootcontroller/post-cancel-action-feedback/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/rootcontroller/post-cancel-action-feedback/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/rootcontroller/post-cancel-action-feedback/path-parameters.adoc[]
|
||||
|
||||
==== Request fields
|
||||
|
||||
include::{snippets}/rootcontroller/post-cancel-action-feedback/request-fields.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/409.adoc[]
|
||||
include::../errors/415.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
== PUT /{tenant}/controller/v1/{targetid}/configData
|
||||
|
||||
=== Implementation notes
|
||||
|
||||
The usual behaviour is that when a new device resgisters at the server it is requested to provide the meta information that will allow the server to identify the device on a hardware level (e.g. hardware revision, mac address, serial number etc.).
|
||||
|
||||
=== Response to a requested metadata pull from the provisioning target device.
|
||||
|
||||
==== Curl
|
||||
|
||||
include::{snippets}/rootcontroller/put-config-data/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/rootcontroller/put-config-data/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/rootcontroller/put-config-data/path-parameters.adoc[]
|
||||
|
||||
==== Request fields
|
||||
|
||||
include::{snippets}/rootcontroller/put-config-data/request-fields.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/409.adoc[]
|
||||
include::../errors/415.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== GET /{tenant}/controller/v1/{targetid}/deploymentBase/{actionId}
|
||||
|
||||
=== Implementation notes
|
||||
|
||||
Core resource for deployment operations. Contains all information necessary in order to execute the operation.
|
||||
|
||||
Keep in mind that the provided download links for the artifacts are generated dynamically by the update server. Host, port and path and not guaranteed to be similar to the provided examples below but will be defined at runtime.
|
||||
|
||||
=== Deployment or update action
|
||||
|
||||
==== Curl
|
||||
|
||||
include::{snippets}/rootcontroller/get-controller-basedeployment-action/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/rootcontroller/get-controller-basedeployment-action/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/rootcontroller/get-controller-basedeployment-action/path-parameters.adoc[]
|
||||
|
||||
==== Request query parameter
|
||||
|
||||
include::{snippets}/rootcontroller/get-controller-basedeployment-action/request-parameters.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/rootcontroller/get-controller-basedeployment-action/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
In this case the (optional) query for the last 10 messages, previously provided by the device, are included. Useful if the devices provide state information previously on the feedback channel and won't store it locally.
|
||||
|
||||
include::{snippets}/rootcontroller/get-controller-basedeployment-action/http-response.adoc[]
|
||||
|
||||
|
||||
=== Response (Status 200) with a maintenance window defined but not active yet
|
||||
|
||||
In addition to the straight forward approach to inform the device to download and install the software in one transaction hawkBit supports the separation of download and installation into separate steps.
|
||||
|
||||
This feature is called Maintenance Window where the device is informed to download the software first and then when it enters a defined (maintenance) window the installation triggers follows as in the example above.
|
||||
|
||||
==== Response example
|
||||
|
||||
Note: artifact details not shown in this example.
|
||||
|
||||
include::{snippets}/rootcontroller/get-controller-basedeployment-action-with-maintenance-window/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
|
||||
|
||||
== POST /{tenant}/controller/v1/{targetid}/deploymentBase/{actionId}/feedback
|
||||
|
||||
|
||||
=== Implementation notes
|
||||
|
||||
Feedback channel. It is up to the device how much intermediate feedback is provided. However, the action will be kept open until the controller on the device reports a finished (either successful or error).
|
||||
|
||||
=== Feedback channel for update action
|
||||
|
||||
==== Curl
|
||||
|
||||
include::{snippets}/rootcontroller/post-basedeployment-action-feedback/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/rootcontroller/post-basedeployment-action-feedback/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/rootcontroller/post-basedeployment-action-feedback/path-parameters.adoc[]
|
||||
|
||||
==== Request fields
|
||||
|
||||
include::{snippets}/rootcontroller/post-basedeployment-action-feedback/request-fields.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/409.adoc[]
|
||||
include::../errors/415.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
////
|
||||
== GET /{tenant}/controller/v1/{targetid}/softwaremodules
|
||||
|
||||
=== Implementation notes
|
||||
|
||||
Returns all available software modules for a given target
|
||||
|
||||
=== Returns software modules of given target
|
||||
|
||||
==== Curl
|
||||
|
||||
include::{snippets}/rootcontroller/get-software-modules/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/rootcontroller/get-software-modules/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/rootcontroller/get-software-modules/path-parameters.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/rootcontroller/get-software-modules/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/rootcontroller/get-software-modules/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
////
|
||||
|
||||
== GET /{tenant}/controller/v1/{targetid}/softwaremodules/{softwareModuleId}/artifacts
|
||||
|
||||
=== Implementation notes
|
||||
|
||||
Returns all artifacts whichs is assigned to the software module
|
||||
|
||||
=== Returns artifacts of given software module
|
||||
|
||||
==== Curl
|
||||
|
||||
include::{snippets}/rootcontroller/get-software-modules-artifacts/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/rootcontroller/get-software-modules-artifacts/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/rootcontroller/get-software-modules-artifacts/path-parameters.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/rootcontroller/get-software-modules-artifacts/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/rootcontroller/get-software-modules-artifacts/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== Additional content
|
||||
|
||||
[[error-body]]
|
||||
=== Error body
|
||||
|
||||
include::../errors/error-response-body.adoc[]
|
||||
@@ -0,0 +1,745 @@
|
||||
:doctype: book
|
||||
:icons: font
|
||||
:source-highlighter: highlightjs
|
||||
:toc: macro
|
||||
:toclevels: 1
|
||||
:sectlinks:
|
||||
:linkattrs:
|
||||
|
||||
[[software-modules]]
|
||||
= Software Modules
|
||||
|
||||
toc::[]
|
||||
|
||||
== GET /rest/v1/softwaremodules
|
||||
|
||||
=== Implementation notes
|
||||
|
||||
Handles the GET request of retrieving all softwaremodules within SP. Required Permission: READ_REPOSITORY
|
||||
|
||||
=== Get software modules
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/softwaremodules/get-software-modules/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/softwaremodules/get-software-modules/http-request.adoc[]
|
||||
|
||||
==== Request parameter
|
||||
|
||||
include::{snippets}/softwaremodules/get-software-modules-with-parameters/request-parameters.adoc[]
|
||||
|
||||
==== Request parameter example
|
||||
|
||||
include::{snippets}/softwaremodules/get-software-modules-with-parameters/http-request.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/softwaremodules/get-software-modules/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/softwaremodules/get-software-modules/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== POST /rest/v1/softwaremodules
|
||||
|
||||
=== Implementation notes
|
||||
|
||||
Handles the POST request of creating new software modules within SP. The request body must always be a list of modules. Required Permission: CREATE_REPOSITORY
|
||||
|
||||
=== Create software modules
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/softwaremodules/post-software-modules/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/softwaremodules/post-software-modules/http-request.adoc[]
|
||||
|
||||
==== Request fields
|
||||
|
||||
include::{snippets}/softwaremodules/post-software-modules/request-fields.adoc[]
|
||||
|
||||
=== Response (Status 201)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/softwaremodules/post-software-modules/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/softwaremodules/post-software-modules/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
| `404 Not Found`
|
||||
| Not Found Software Module.
|
||||
| See <<error-body>>
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/409.adoc[]
|
||||
include::../errors/415.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== DELETE /rest/v1/softwaremodules/{softwareModuleId}
|
||||
|
||||
=== Implementation Notes
|
||||
|
||||
Handles the DELETE request for a single softwaremodule within SP. Required Permission: DELETE_REPOSITORY
|
||||
|
||||
=== Delete software module
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/softwaremodules/delete-software-module/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/softwaremodules/delete-software-module/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/softwaremodules/delete-software-module/path-parameters.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/softwaremodules/delete-software-module/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
| `404 Not Found`
|
||||
| Not Found Software Module.
|
||||
| See <<error-body>>
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== GET /rest/v1/softwaremodules/{softwareModuleId}
|
||||
|
||||
=== Implementation notes
|
||||
|
||||
Handles the GET request of retrieving a single softwaremodule within SP. Required Permission: READ_REPOSITORY
|
||||
|
||||
=== Get software module
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/softwaremodules/get-software-module/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/softwaremodules/get-software-module/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/softwaremodules/get-software-module/path-parameters.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/softwaremodules/get-software-module/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/softwaremodules/get-software-module/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
| `404 Not Found`
|
||||
| Not Found Software Module.
|
||||
| See <<error-body>>
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== PUT /rest/v1/softwaremodules/{softwareModuleId}
|
||||
|
||||
=== Implementation notes
|
||||
|
||||
Handles the PUT request for a single softwaremodule within SP. Required Permission: UPDATE_REPOSITORY
|
||||
|
||||
=== Update software module
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/softwaremodules/put-software-module/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/softwaremodules/put-software-module/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/softwaremodules/put-software-module/path-parameters.adoc[]
|
||||
|
||||
==== Request fields
|
||||
|
||||
include::{snippets}/softwaremodules/put-software-module/request-fields.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/softwaremodules/put-software-module/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/softwaremodules/put-software-module/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
| `404 Not Found`
|
||||
| Not Found Software Module.
|
||||
| See <<error-body>>
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/409.adoc[]
|
||||
include::../errors/415.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== GET /rest/v1/softwaremodules/{softwareModuleId}/artifacts
|
||||
|
||||
=== Implementation notes
|
||||
|
||||
Handles the GET request of retrieving all meta data of artifacts assigned to a software module. Required Permission: READ_REPOSITORY
|
||||
|
||||
=== List artifacts metadata
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/softwaremodules/get-artifacts/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/softwaremodules/get-artifacts/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/softwaremodules/get-artifacts/path-parameters.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/softwaremodules/get-artifacts/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/softwaremodules/get-artifacts/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
| `404 Not Found`
|
||||
| Not Found Software Module.
|
||||
| See <<error-body>>
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== POST /rest/v1/softwaremodules/{softwareModuleId}/artifacts
|
||||
|
||||
=== Implementation notes
|
||||
|
||||
Handles POST request for artifact upload. Required Permission: CREATE_REPOSITORY
|
||||
|
||||
=== Upload artifact
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/softwaremodules/post-artifact/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/softwaremodules/post-artifact/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/softwaremodules/post-artifact/path-parameters.adoc[]
|
||||
|
||||
==== Request query parameter
|
||||
|
||||
include::{snippets}/softwaremodules/post-artifact-with-parameters/request-parameters.adoc[]
|
||||
|
||||
==== Request parameter example
|
||||
|
||||
include::{snippets}/softwaremodules/post-artifact-with-parameters/http-request.adoc[]
|
||||
|
||||
=== Response (Status 201)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/softwaremodules/post-artifact/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/softwaremodules/post-artifact/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
| `404 Not Found`
|
||||
| Not Found Software Module.
|
||||
| See <<error-body>>
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/415.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== DELETE /rest/v1/softwaremodules/{softwareModuleId}/artifacts/{artifactId}
|
||||
|
||||
=== Implementation Notes
|
||||
|
||||
Handles the DELETE request for a single SoftwareModule within SP. Required Permission: DELETE_REPOSITORY
|
||||
|
||||
=== Delete arifact
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/softwaremodules/delete-artifact/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/softwaremodules/delete-artifact/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/softwaremodules/delete-artifact/path-parameters.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/softwaremodules/delete-artifact/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
| `404 Not Found`
|
||||
| Not Found Software Module.
|
||||
| See <<error-body>>
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== GET /rest/v1/softwaremodules/{softwareModuleId}/artifacts/{artifactId}
|
||||
|
||||
=== Implementation notes
|
||||
|
||||
Handles the GET request of retrieving a single Artifact meta data request. Required Permission: READ_REPOSITORY
|
||||
|
||||
=== Get artifact metadata
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/softwaremodules/get-artifact/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/softwaremodules/get-artifact/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/softwaremodules/get-artifact/path-parameters.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/softwaremodules/get-artifact/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/softwaremodules/get-artifact/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
| `404 Not Found`
|
||||
| Not Found Software Module.
|
||||
| See <<error-body>>
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== GET /rest/v1/softwaremodules/{softwareModuleId}/artifacts/{artifactId}/download
|
||||
|
||||
=== Implementation notes
|
||||
|
||||
Handles the GET request for downloading an artifact. Required Permission: READ_REPOSITORY
|
||||
|
||||
=== Download artifact
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/softwaremodules/get-download-artifact/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/softwaremodules/get-download-artifact/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/softwaremodules/get-download-artifact/path-parameters.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/softwaremodules/get-download-artifact/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
| `404 Not Found`
|
||||
| Not Found Software Module.
|
||||
| See <<error-body>>
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== GET /rest/v1/softwaremodules/{softwareModuleId}/metadata
|
||||
|
||||
=== Implementation notes
|
||||
|
||||
Get a paged list of meta data for a software module. Required Permission: READ_REPOSITORY
|
||||
|
||||
=== Get a paged list of metadata
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/softwaremodules/get-metadata/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/softwaremodules/get-metadata/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/softwaremodules/get-metadata/path-parameters.adoc[]
|
||||
|
||||
==== Request query parameter
|
||||
|
||||
include::{snippets}/softwaremodules/get-metadata-with-parameters/request-parameters.adoc[]
|
||||
|
||||
==== Request parameter example
|
||||
|
||||
include::{snippets}/softwaremodules/get-metadata-with-parameters/http-request.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/softwaremodules/get-metadata/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/softwaremodules/get-metadata/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
| `404 Not Found`
|
||||
| Not Found Software Module.
|
||||
| See <<error-body>>
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== POST /rest/v1/softwaremodules/{softwareModuleId}/metadata
|
||||
|
||||
=== Implementation notes
|
||||
|
||||
Create a list of meta data entries Required Permission: UPDATE_REPOSITORY
|
||||
|
||||
=== Create a list of metadata entries
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/softwaremodules/post-metadata/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/softwaremodules/post-metadata/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/softwaremodules/post-metadata/path-parameters.adoc[]
|
||||
|
||||
==== Request fields
|
||||
|
||||
include::{snippets}/softwaremodules/post-metadata/request-fields.adoc[]
|
||||
|
||||
=== Response (Status 201)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/softwaremodules/post-metadata/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/softwaremodules/post-metadata/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
| `404 Not Found`
|
||||
| Not Found Software Module.
|
||||
| See <<error-body>>
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/409.adoc[]
|
||||
include::../errors/415.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
== DELETE /rest/v1/softwaremodules/{softwareModuleId}/metadata/{metadataKey}
|
||||
|
||||
=== Implementation Notes
|
||||
|
||||
Delete a single meta data. Required Permission: UPDATE_REPOSITORY
|
||||
|
||||
=== Deleting a single metadata
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/softwaremodules/delete-metadata/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/softwaremodules/delete-metadata/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/softwaremodules/delete-metadata/path-parameters.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/softwaremodules/delete-metadata/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
| `404 Not Found`
|
||||
| Not Found Software Module.
|
||||
| See <<error-body>>
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== GET /rest/v1/softwaremodules/{softwareModuleId}/metadata/{metadataKey}
|
||||
|
||||
=== Implementation notes
|
||||
|
||||
Get a single meta data value for a meta data key. Required Permission: READ_REPOSITORY
|
||||
|
||||
=== Get a single metadata value
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/softwaremodules/get-metadata-value/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/softwaremodules/get-metadata-value/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/softwaremodules/get-metadata-value/path-parameters.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/softwaremodules/get-metadata-value/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/softwaremodules/get-metadata-value/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
| `404 Not Found`
|
||||
| Not Found Software Module.
|
||||
| See <<error-body>>
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== PUT /rest/v1/softwaremodules/{softwareModuleId}/metadata/{metadataKey}
|
||||
|
||||
=== Implementation notes
|
||||
|
||||
Update a single meta data value for speficic key. Required Permission: UPDATE_REPOSITORY
|
||||
|
||||
=== Updating a single metadata value
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/softwaremodules/put-metadata/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/softwaremodules/put-metadata/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/softwaremodules/put-metadata/path-parameters.adoc[]
|
||||
|
||||
==== Request fields
|
||||
|
||||
include::{snippets}/softwaremodules/put-metadata/request-fields.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/softwaremodules/put-metadata/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/softwaremodules/put-software-module/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
| `404 Not Found`
|
||||
| Not Found Software Module.
|
||||
| See <<error-body>>
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== Additional content
|
||||
|
||||
[[error-body]]
|
||||
=== Error body
|
||||
|
||||
include::../errors/error-response-body.adoc[]
|
||||
|
||||
|
||||
@@ -0,0 +1,255 @@
|
||||
:doctype: book
|
||||
:icons: font
|
||||
:source-highlighter: highlightjs
|
||||
:toc: macro
|
||||
:toclevels: 1
|
||||
:sectlinks:
|
||||
:linkattrs:
|
||||
|
||||
[[software-module-types]]
|
||||
= Software Module Types
|
||||
|
||||
toc::[]
|
||||
|
||||
== GET /rest/v1/softwaremoduletypes
|
||||
|
||||
=== Implementation notes
|
||||
|
||||
Handles the GET request of retrieving all software module types within SP. Required Permission: READ_REPOSITORY
|
||||
|
||||
=== Get software module types
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/softwaremoduletypes/get-software-module-types/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/softwaremoduletypes/get-software-module-types/http-request.adoc[]
|
||||
|
||||
==== Request query parameter
|
||||
|
||||
include::{snippets}/softwaremoduletypes/get-software-module-types-with-parameters/request-parameters.adoc[]
|
||||
|
||||
==== Request parameter example
|
||||
|
||||
include::{snippets}/softwaremoduletypes/get-software-module-types-with-parameters/http-request.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/softwaremoduletypes/get-software-module-types/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/softwaremoduletypes/get-software-module-types/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== POST /rest/v1/softwaremoduletypes
|
||||
|
||||
=== Implementation notes
|
||||
|
||||
Handles the POST request of creating new software module types within SP. The request body must always be a list of module types. Required Permission: CREATE_REPOSITORY
|
||||
|
||||
=== Creating software module types
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/softwaremoduletypes/post-software-module-types/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/softwaremoduletypes/post-software-module-types/http-request.adoc[]
|
||||
|
||||
==== Request fields
|
||||
|
||||
include::{snippets}/softwaremoduletypes/post-software-module-types/request-fields.adoc[]
|
||||
|
||||
=== Response (Status 201)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/softwaremoduletypes/post-software-module-types/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/softwaremoduletypes/post-software-module-types/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
| `404 Not Found`
|
||||
| Not Found Software Module Type.
|
||||
| See <<error-body>>
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/409.adoc[]
|
||||
include::../errors/415.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== DELETE /rest/v1/softwaremoduletypes/{softwareModuleTypeId}
|
||||
|
||||
=== Implementation Notes
|
||||
|
||||
Handles the DELETE request for a single software module type within SP. Required Permission: DELETE_REPOSITORY
|
||||
|
||||
=== Delete software module type
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/softwaremoduletypes/delete-software-module-type/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/softwaremoduletypes/delete-software-module-type/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/softwaremoduletypes/delete-software-module-type/path-parameters.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/softwaremoduletypes/delete-software-module-type/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/404.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== GET /rest/v1/softwaremoduletypes/{softwareModuleTypeId}
|
||||
|
||||
=== Implementation notes
|
||||
|
||||
Handles the GET request of retrieving a single software module type within SP. Required Permission: READ_REPOSITORY
|
||||
|
||||
=== Accessing a software module type
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/softwaremoduletypes/get-software-module-type/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/softwaremoduletypes/get-software-module-type/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/softwaremoduletypes/get-software-module-type/path-parameters.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/softwaremoduletypes/get-software-module-type/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/softwaremoduletypes/get-software-module-type/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== PUT /rest/v1/softwaremoduletypes/{softwareModuleTypeId}
|
||||
|
||||
=== Implementation notes
|
||||
|
||||
Handles the PUT request for a single software module type within SP. Required Permission: UPDATE_REPOSITORY
|
||||
|
||||
=== Updating a software module types
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/softwaremoduletypes/put-software-module-type/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/softwaremoduletypes/put-software-module-type/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/softwaremoduletypes/put-software-module-type/path-parameters.adoc[]
|
||||
|
||||
==== Request fields
|
||||
|
||||
include::{snippets}/softwaremoduletypes/put-software-module-type/request-fields.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/softwaremoduletypes/put-software-module-type/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/softwaremoduletypes/put-software-module-type/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
| `404 Not Found`
|
||||
| Not Found Software Module Type.
|
||||
| See <<error-body>>
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/409.adoc[]
|
||||
include::../errors/415.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== Additional content
|
||||
|
||||
[[error-body]]
|
||||
=== Error body
|
||||
|
||||
include::../errors/error-response-body.adoc[]
|
||||
|
||||
@@ -0,0 +1,392 @@
|
||||
:doctype: book
|
||||
:icons: font
|
||||
:source-highlighter: highlightjs
|
||||
:toc: macro
|
||||
:toclevels: 1
|
||||
:sectlinks:
|
||||
:linkattrs:
|
||||
|
||||
[[targetfilters]]
|
||||
= Target filter queries
|
||||
|
||||
toc::[]
|
||||
|
||||
|
||||
== GET /rest/v1/targetfilters
|
||||
|
||||
=== Implementation notes
|
||||
|
||||
Handles the GET request of retrieving all target filter queries within SP. Required permission: READ_TARGET
|
||||
|
||||
=== Get paged list of target filter queries
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/targetfilters/get-target-filter-queries/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
A `GET` request is used to access the target filter queries
|
||||
|
||||
include::{snippets}/targetfilters/get-target-filter-queries/http-request.adoc[]
|
||||
|
||||
==== Request query parameter
|
||||
|
||||
include::{snippets}/targetfilters/get-target-filter-queries-with-parameters/request-parameters.adoc[]
|
||||
|
||||
==== Request parameter example
|
||||
|
||||
include::{snippets}/targetfilters/get-target-filter-queries-with-parameters/http-request.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/targetfilters/get-target-filter-queries/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/targetfilters/get-target-filter-queries/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== POST /rest/v1/targetfilters
|
||||
|
||||
=== Implementation Notes
|
||||
|
||||
Handles the POST request to create a new target filter query within SP. Required permission: CREATE_TARGET
|
||||
|
||||
=== Create a target filter query
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/targetfilters/post-target-filter-query/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/targetfilters/post-target-filter-query/http-request.adoc[]
|
||||
|
||||
==== Request fields
|
||||
|
||||
include::{snippets}/targetfilters/post-target-filter-query/request-fields.adoc[]
|
||||
|
||||
=== Response (Status 201)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/targetfilters/post-target-filter-query/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/targetfilters/post-target-filter-query/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403_quota.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/409.adoc[]
|
||||
include::../errors/415.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== DELETE /rest/v1/targetfilters/{targetFilterQueryId}
|
||||
|
||||
=== Implementation Notes
|
||||
|
||||
Handles the DELETE request of deleting a target filter query within SP. Required permission: DELETE_TARGET
|
||||
|
||||
=== Deleting a target
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/targetfilters/delete-target-filter-query/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/targetfilters/delete-target-filter-query/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/targetfilters/delete-target-filter-query/path-parameters.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/targetfilters/delete-target-filter-query/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/404.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== GET /rest/v1/targetfilters/{targetFilterQueryId}
|
||||
|
||||
=== Implementation Notes
|
||||
|
||||
Handles the GET request of retrieving a single target filter query within SP. Required permission: READ_TARGET
|
||||
|
||||
=== Get single target
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/targetfilters/get-target-filter-query/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/targetfilters/get-target-filter-query/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/targetfilters/get-target-filter-query/path-parameters.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/targetfilters/get-target-filter-query/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/targetfilters/get-target-filter-query/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/404.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== PUT /rest/v1/targetfilters/{targetFilterQueryId}
|
||||
|
||||
=== Implementation Notes
|
||||
|
||||
Handles the PUT request of updating a target filter query within SP. Required permission: UPDATE_TARGET
|
||||
|
||||
=== Update a target
|
||||
|
||||
==== Curl
|
||||
|
||||
include::{snippets}/targetfilters/put-target-filter-query/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/targetfilters/put-target-filter-query/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/targetfilters/put-target-filter-query/path-parameters.adoc[]
|
||||
|
||||
==== Request fields
|
||||
|
||||
include::{snippets}/targetfilters/put-target-filter-query/request-fields.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/targetfilters/put-target-filter-query/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/targetfilters/put-target-filter-query/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/404.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/409.adoc[]
|
||||
include::../errors/415.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== GET /rest/v1/targetfilters/{targetFilterQueryId}/autoAssignDS
|
||||
|
||||
=== Implementation Notes
|
||||
|
||||
Handles the GET request of retrieving the auto assign distribution set. Required permission: READ_TARGET
|
||||
|
||||
=== Get auto assign distribution set
|
||||
|
||||
==== Curl
|
||||
|
||||
include::{snippets}/targetfilters/get-assign-d-s/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/targetfilters/get-assign-d-s/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/targetfilters/get-assign-d-s/path-parameters.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/targetfilters/get-assign-d-s/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/targetfilters/get-assign-d-s/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== POST /rest/v1/targetfilters/{targetFilterQueryId}/autoAssignDS
|
||||
|
||||
=== Implementation Notes
|
||||
|
||||
Handles the POST request of setting the auto assign distribution set for a target filter query.
|
||||
Required permissions: UPDATE_TARGET and READ_REPOSITORY
|
||||
|
||||
=== Set auto assign distribution set
|
||||
|
||||
==== Curl
|
||||
|
||||
include::{snippets}/targetfilters/post-auto-assign-d-s/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/targetfilters/post-auto-assign-d-s/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/targetfilters/post-auto-assign-d-s/path-parameters.adoc[]
|
||||
|
||||
==== Request fields
|
||||
|
||||
include::{snippets}/targetfilters/post-auto-assign-d-s/request-fields.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/targetfilters/post-auto-assign-d-s/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/targetfilters/post-auto-assign-d-s/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/404.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/415.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== DELETE /rest/v1/targetfilters/{targetFilterQueryId}/autoAssignDS
|
||||
|
||||
=== Implementation Notes
|
||||
|
||||
Removes the auto assign distribution set from the target filter query. Required permission: UPDATE_TARGET
|
||||
|
||||
=== Removing the auto assign distribution set
|
||||
|
||||
==== Curl
|
||||
|
||||
include::{snippets}/targetfilters/delete-auto-assign-d-s/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/targetfilters/delete-auto-assign-d-s/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/targetfilters/delete-auto-assign-d-s/path-parameters.adoc[]
|
||||
|
||||
=== Response (Status 204)
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/targetfilters/delete-auto-assign-d-s/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/404.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
|
||||
== Additional content
|
||||
|
||||
[[error-body]]
|
||||
=== Error body
|
||||
|
||||
include::../errors/error-response-body.adoc[]
|
||||
|
||||
|
||||
@@ -0,0 +1,694 @@
|
||||
:doctype: book
|
||||
:icons: font
|
||||
:source-highlighter: highlightjs
|
||||
:toc: macro
|
||||
:toclevels: 1
|
||||
:sectlinks:
|
||||
:linkattrs:
|
||||
|
||||
[[targets]]
|
||||
= Targets
|
||||
|
||||
toc::[]
|
||||
|
||||
|
||||
== GET /rest/v1/targets
|
||||
|
||||
=== Implementation notes
|
||||
|
||||
Handles the GET request of retrieving all targets within SP. Required permission: READ_TARGET
|
||||
|
||||
=== Get paged list of targets
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/targets/get-targets/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
A `GET` request is used to access the targets
|
||||
|
||||
include::{snippets}/targets/get-targets/http-request.adoc[]
|
||||
|
||||
==== Request query parameter
|
||||
|
||||
include::{snippets}/targets/get-targets-with-parameters/request-parameters.adoc[]
|
||||
|
||||
==== Request parameter example
|
||||
|
||||
include::{snippets}/targets/get-targets-with-parameters/http-request.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/targets/get-targets/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/targets/get-targets/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== POST /rest/v1/targets
|
||||
|
||||
=== Implementation Notes
|
||||
|
||||
Handles the POST request of creating new targets within SP. The request body must always be a list of targets. Required Permission: CREATE_TARGET
|
||||
|
||||
=== Create list of targets
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/targets/post-targets/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/targets/post-targets/http-request.adoc[]
|
||||
|
||||
==== Request fields
|
||||
|
||||
include::{snippets}/targets/post-targets/request-fields.adoc[]
|
||||
|
||||
=== Response (Status 201)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/targets/post-targets/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/targets/post-targets/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403_quota.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/409.adoc[]
|
||||
include::../errors/415.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== DELETE /rest/v1/targets/{targetId}
|
||||
|
||||
=== Implementation Notes
|
||||
|
||||
Handles the DELETE request of deleting a single target within SP. Required Permission: DELETE_TARGET
|
||||
|
||||
=== Deleting a target
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/targets/delete-target/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/targets/delete-target/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/targets/delete-target/path-parameters.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/targets/delete-target/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/404.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== GET /rest/v1/targets/{targetId}
|
||||
|
||||
=== Implementation Notes
|
||||
|
||||
Handles the GET request of retrieving a single target within SP. Required Permission: READ_TARGET
|
||||
|
||||
=== Get single target
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/targets/get-target/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/targets/get-target/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/targets/get-target/path-parameters.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/targets/get-target/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/targets/get-target/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/404.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== PUT /rest/v1/targets/{targetId}
|
||||
|
||||
=== Implementation Notes
|
||||
|
||||
Handles the PUT request of updating a target within SP. Required Permission: UPDATE_TARGET
|
||||
|
||||
=== Update a target
|
||||
|
||||
==== Curl
|
||||
|
||||
include::{snippets}/targets/put-target/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/targets/put-target/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/targets/put-target/path-parameters.adoc[]
|
||||
|
||||
==== Request fields
|
||||
|
||||
include::{snippets}/targets/put-target/request-fields.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/targets/put-target/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/targets/put-target/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/404.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/409.adoc[]
|
||||
include::../errors/415.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== GET /rest/v1/targets/{targetId}/actions
|
||||
|
||||
=== Implementation Notes
|
||||
|
||||
Handles the GET request of retrieving the full action history of a specific target. Required Permission: READ_TARGET
|
||||
|
||||
=== List all actions of Target
|
||||
|
||||
==== Curl
|
||||
|
||||
include::{snippets}/targets/get-actions-from-target/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/targets/get-actions-from-target/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/targets/get-actions-from-target/path-parameters.adoc[]
|
||||
|
||||
==== Request query parameter
|
||||
|
||||
include::{snippets}/targets/get-actions-from-target-with-parameters/request-parameters.adoc[]
|
||||
|
||||
==== Request parameter example
|
||||
|
||||
include::{snippets}/targets/get-actions-from-target-with-parameters/http-request.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/targets/get-actions-from-target-with-maintenance-window/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/targets/get-actions-from-target/http-response.adoc[]
|
||||
|
||||
==== Response example with Maintenance Window
|
||||
|
||||
include::{snippets}/targets/get-actions-from-target-with-maintenance-window/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== PUT /rest/v1/targets/{targetId}/actions/{actionId}
|
||||
|
||||
=== Implementation Notes
|
||||
|
||||
Handles the PUT request to switch an action from soft to forced. Required Permission: UPDATE_TARGET.
|
||||
|
||||
=== Update a target
|
||||
|
||||
==== Curl
|
||||
|
||||
include::{snippets}/targets/switch-action-to-forced/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/targets/switch-action-to-forced/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/targets/switch-action-to-forced/path-parameters.adoc[]
|
||||
|
||||
==== Request fields
|
||||
|
||||
include::{snippets}/targets/switch-action-to-forced/request-fields.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/targets/switch-action-to-forced/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/targets/switch-action-to-forced/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/404.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/409.adoc[]
|
||||
include::../errors/415.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
== DELETE /rest/v1/targets/{targetId}/actions/{actionId}
|
||||
|
||||
=== Implementation Notes
|
||||
|
||||
Cancels an active action, only active actions can be deleted. Required Permission: UPDATE_TARGET
|
||||
|
||||
=== Canceling an active action
|
||||
|
||||
==== Curl
|
||||
|
||||
include::{snippets}/targets/delete-action-from-target/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/targets/delete-action-from-target/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/targets/delete-action-from-target/path-parameters.adoc[]
|
||||
|
||||
==== Request query parameter
|
||||
|
||||
include::{snippets}/targets/delete-actions-from-target-with-parameters/request-parameters.adoc[]
|
||||
|
||||
==== Request parameter example
|
||||
|
||||
include::{snippets}/targets/delete-actions-from-target-with-parameters/http-request.adoc[]
|
||||
|
||||
=== Response (Status 204)
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/targets/delete-action-from-target/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/404.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== GET /rest/v1/targets/{targetId}/actions/{actionId}
|
||||
|
||||
=== Implementation Notes
|
||||
|
||||
Handles the GET request of retrieving a specific action on a specific target. Required Permission: READ_TARGET
|
||||
|
||||
=== Get assigned action of target
|
||||
|
||||
==== Curl
|
||||
|
||||
include::{snippets}/targets/get-action-from-target/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/targets/get-action-from-target/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/targets/get-action-from-target/path-parameters.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/targets/get-action-from-target-with-maintenance-window/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/targets/get-action-from-target/http-response.adoc[]
|
||||
|
||||
==== Response example with Maintenance Window
|
||||
|
||||
include::{snippets}/targets/get-action-from-target-with-maintenance-window/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/404.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== GET /rest/v1/targets/{targetId}/actions/{actionId}/status
|
||||
|
||||
=== Implementation Notes
|
||||
|
||||
Handles the GET request of retrieving a specific action on a specific target. Required Permission: READ_TARGET
|
||||
|
||||
=== Get statuses of assigned action
|
||||
|
||||
==== Curl
|
||||
|
||||
include::{snippets}/targets/get-status-from-action/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/targets/get-status-from-action/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/targets/get-status-from-action/path-parameters.adoc[]
|
||||
|
||||
==== Request parameter
|
||||
|
||||
include::{snippets}/targets/get-status-from-action-with-parameters/request-parameters.adoc[]
|
||||
|
||||
==== Request parameter example
|
||||
|
||||
include::{snippets}/targets/get-status-from-action-with-parameters/http-request.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/targets/get-status-from-action/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/targets/get-status-from-action/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/404.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== GET /rest/v1/targets/{targetId}/assignedDS
|
||||
|
||||
=== Implementation Notes
|
||||
|
||||
Handles the GET request of retrieving the assigned distribution set of an specific target. Required Permission: READ_TARGET
|
||||
|
||||
=== Get assigned distribution set of target
|
||||
|
||||
==== Curl
|
||||
|
||||
include::{snippets}/targets/get-assigned-distribution-set-from-action/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/targets/get-assigned-distribution-set-from-action/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/targets/get-assigned-distribution-set-from-action/path-parameters.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/targets/get-assigned-distribution-set-from-action/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/targets/get-assigned-distribution-set-from-action/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/404.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== POST /rest/v1/targets/{targetId}/assignedDS
|
||||
|
||||
=== Implementation Notes
|
||||
|
||||
Handles the POST request for assigning a distribution set to a specific target. Required Permission: READ_REPOSITORY and UPDATE_TARGET
|
||||
|
||||
=== Asssin distribution set to target
|
||||
|
||||
==== Curl
|
||||
|
||||
include::{snippets}/targets/post-assign-distribution-set-to-target/curl-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/targets/post-assign-distribution-set-to-target/path-parameters.adoc[]
|
||||
|
||||
==== Request query parameter
|
||||
|
||||
include::{snippets}/targets/post-assign-distribution-set-to-target/request-parameters.adoc[]
|
||||
|
||||
==== Request fields
|
||||
|
||||
include::{snippets}/targets/post-assign-distribution-set-to-target/request-fields.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/targets/post-assign-distribution-set-to-target/http-request.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/targets/post-assign-distribution-set-to-target/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/404.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/409.adoc[]
|
||||
include::../errors/415.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== GET /rest/v1/targets/{targetId}/attributes
|
||||
|
||||
=== Implementation Notes
|
||||
|
||||
Handles the GET request of retrieving the attributes of a specific target. Reponse is a key/value list. Required Permission: READ_TARGET
|
||||
|
||||
=== Get attributes of target
|
||||
|
||||
==== Curl
|
||||
|
||||
include::{snippets}/targets/get-controller-attributes/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/targets/get-controller-attributes/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/targets/get-controller-attributes/path-parameters.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/targets/get-controller-attributes/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/404.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== GET /rest/v1/targets/{targetId}/installedDS
|
||||
|
||||
=== Implementation Notes
|
||||
|
||||
Handles the GET request of retrieving the installed distribution set of an specific target. Required Permission: READ_TARGET
|
||||
|
||||
=== Get installed distribution set of target
|
||||
|
||||
==== Curl
|
||||
|
||||
include::{snippets}/targets/get-installed-distribution-set-from-target/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/targets/get-installed-distribution-set-from-target/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/targets/get-installed-distribution-set-from-target/path-parameters.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/targets/get-installed-distribution-set-from-target/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/targets/get-installed-distribution-set-from-target/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/404.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== Additional content
|
||||
|
||||
[[error-body]]
|
||||
=== Error body
|
||||
|
||||
include::../errors/error-response-body.adoc[]
|
||||
|
||||
|
||||
@@ -0,0 +1,431 @@
|
||||
:doctype: book
|
||||
:icons: font
|
||||
:source-highlighter: highlightjs
|
||||
:toc: macro
|
||||
:toclevels: 1
|
||||
:sectlinks:
|
||||
:linkattrs:
|
||||
|
||||
[[targettag]]
|
||||
= Target Tag
|
||||
|
||||
toc::[]
|
||||
|
||||
|
||||
== GET /rest/v1/targettags
|
||||
|
||||
=== Implementation notes
|
||||
|
||||
Handles the GET request of retrieving all target tags.
|
||||
|
||||
=== Get paged list of target tags
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/targettag/get-target-tags/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
A `GET` request is used to access the target tags
|
||||
|
||||
include::{snippets}/targettag/get-target-tags/http-request.adoc[]
|
||||
|
||||
==== Request query parameter
|
||||
|
||||
include::{snippets}/targettag/get-target-tags-with-parameters/request-parameters.adoc[]
|
||||
|
||||
==== Request parameter example
|
||||
|
||||
include::{snippets}/targettag/get-target-tags-with-parameters/http-request.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/targettag/get-target-tags/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/targettag/get-target-tags/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== GET /rest/v1/targettags/{targetTagId}
|
||||
|
||||
=== Implementation notes
|
||||
|
||||
Handles the GET request of retrieving a single target tag.
|
||||
|
||||
=== Get a single target tag
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/targettag/get-target-tag/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
A `GET` request is used to access the target tag
|
||||
|
||||
include::{snippets}/targettag/get-target-tag/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/targettag/get-target-tag/path-parameters.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/targettag/get-target-tag/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/targettag/get-target-tag/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== POST /rest/v1/targettags
|
||||
|
||||
=== Implementation Notes
|
||||
|
||||
Handles the POST request of creating new target tag. The request body must always be a list of target tags.
|
||||
|
||||
=== Create list of target tags
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/targettag/create-target-tags/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/targettag/create-target-tags/http-request.adoc[]
|
||||
|
||||
==== Request fields
|
||||
|
||||
include::{snippets}/targettag/create-target-tags/request-fields.adoc[]
|
||||
|
||||
=== Response (Status 201)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/targettag/create-target-tags/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/targettag/create-target-tags/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/409.adoc[]
|
||||
include::../errors/415.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
== PUT /rest/v1/targettags/{targetTagId}
|
||||
|
||||
=== Implementation Notes
|
||||
|
||||
Handles the PUT request of updating a target tag.
|
||||
|
||||
=== Update a target tag
|
||||
|
||||
==== Curl
|
||||
|
||||
include::{snippets}/targettag/update-tagret-tag/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/targettag/update-tagret-tag/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/targettag/update-tagret-tag/path-parameters.adoc[]
|
||||
|
||||
==== Request fields
|
||||
|
||||
include::{snippets}/targettag/update-tagret-tag/request-fields.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/targettag/update-tagret-tag/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/targettag/update-tagret-tag/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/404.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/409.adoc[]
|
||||
include::../errors/415.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== DELETE /rest/v1/targettags/{targetTagId}
|
||||
|
||||
=== Implementation Notes
|
||||
|
||||
Handles the DELETE request of deleting a single target tag.
|
||||
|
||||
=== Deleting a target tag
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/targettag/delete-target-tag/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/targettag/delete-target-tag/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/targettag/delete-target-tag/path-parameters.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/targettag/delete-target-tag/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/404.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== GET /rest/v1/targettags/{targetTagId}/assigned
|
||||
|
||||
=== Implementation Notes
|
||||
|
||||
Handles the GET request of retrieving a list of assigned targets.
|
||||
|
||||
=== Get a list of assigned targets
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/targettag/get-assigned-targets/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/targettag/get-assigned-targets/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/targettag/get-assigned-targets/path-parameters.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/targettag/get-assigned-targets/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/targettag/get-assigned-targets/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/404.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
|
||||
== POST /rest/v1/targettags/{targetTagId}/assigned/toggleTagAssignment
|
||||
|
||||
=== Implementation Notes
|
||||
|
||||
Handles the POST request of toogle target assignment. The request body must always be a list of controller ids.
|
||||
|
||||
=== Toogle target assignment
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/targettag/toggle-tag-assignment/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/targettag/toggle-tag-assignment/http-request.adoc[]
|
||||
|
||||
==== Request fields
|
||||
|
||||
include::{snippets}/targettag/toggle-tag-assignment/request-fields.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/targettag/toggle-tag-assignment/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/targettag/toggle-tag-assignment/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/409.adoc[]
|
||||
include::../errors/415.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
== POST /rest/v1/targettags/{targetTagId}/assigned
|
||||
|
||||
=== Implementation Notes
|
||||
|
||||
Handles the POST request of target assignment. Already assigned target will be ignored.
|
||||
|
||||
=== Target assignment
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/targettag/assign-targets/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/targettag/assign-targets/http-request.adoc[]
|
||||
|
||||
==== Request fields
|
||||
|
||||
include::{snippets}/targettag/assign-targets/request-fields.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/targettag/assign-targets/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/targettag/assign-targets/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/409.adoc[]
|
||||
include::../errors/415.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
== DELETE /rest/v1/targettags/{targetTagId}/assigned/{controllerId}
|
||||
|
||||
=== Implementation Notes
|
||||
|
||||
Handles the DELETE request to unassign the given target.
|
||||
|
||||
=== Unassign a target
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/targettag/unassign-target/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/targettag/unassign-target/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/targettag/unassign-target/path-parameters.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/targettag/unassign-target/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/404.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
== Additional content
|
||||
|
||||
[[error-body]]
|
||||
=== Error body
|
||||
|
||||
include::../errors/error-response-body.adoc[]
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,194 @@
|
||||
:doctype: book
|
||||
:icons: font
|
||||
:source-highlighter: highlightjs
|
||||
:toc: macro
|
||||
:toclevels: 1
|
||||
:sectlinks:
|
||||
:linkattrs:
|
||||
|
||||
[[tenant]]
|
||||
= System Configuration
|
||||
|
||||
toc::[]
|
||||
|
||||
|
||||
== GET /rest/v1/system/configs
|
||||
|
||||
=== Implementation notes
|
||||
|
||||
The GET request returns a list of all possible configuration keys for the tenant. Required Permission: TENANT_CONFIGURATION
|
||||
|
||||
=== Get all configuration parameters
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/tenant/get-tenant-configrations/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/tenant/get-tenant-configrations/http-request.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/tenant/get-tenant-configrations/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/tenant/get-tenant-configrations/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/404.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
== GET /rest/v1/system/configs/{keyName}
|
||||
|
||||
=== Implementation notes
|
||||
|
||||
The GET request returns the configuration value of a specific configuration key for the tenant. Required Permission: TENANT_CONFIGURATION
|
||||
|
||||
=== Read a configuration parameter
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/tenant/get-tenant-configration/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/tenant/get-tenant-configration/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/tenant/get-tenant-configration/path-parameters.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/tenant/get-tenant-configration/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/tenant/get-tenant-configration/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/404.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
== PUT /rest/v1/system/configs/{keyName}
|
||||
|
||||
=== Implementation notes
|
||||
|
||||
The PUT request changes a configuration value of a specific configuration key for the tenant. Required Permission: TENANT_CONFIGURATION
|
||||
|
||||
=== Change a configuration parameter
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/tenant/put-tenant-configration/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/tenant/put-tenant-configration/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/tenant/put-tenant-configration/path-parameters.adoc[]
|
||||
|
||||
==== Request fields
|
||||
|
||||
include::{snippets}/tenant/put-tenant-configration/request-fields.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/tenant/put-tenant-configration/response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/tenant/put-tenant-configration/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/404.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/409.adoc[]
|
||||
include::../errors/415.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
== DELETE /rest/v1/system/configs/{keyName}
|
||||
|
||||
=== Implementation notes
|
||||
|
||||
The DELETE request removes a tenant specific configuration value for the tenant. Afterwards the global default value is used. Required Permission: TENANT_CONFIGURATION
|
||||
|
||||
=== Removes a configuration parameter
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/tenant/delete-tenant-configration/curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/tenant/delete-tenant-configration/http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/tenant/delete-tenant-configration/path-parameters.adoc[]
|
||||
|
||||
=== Response (Status 204)
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/tenant/delete-tenant-configration/http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
|===
|
||||
| HTTP Status Code | Reason | Response Model
|
||||
|
||||
include::../errors/400.adoc[]
|
||||
include::../errors/401.adoc[]
|
||||
include::../errors/403.adoc[]
|
||||
include::../errors/404.adoc[]
|
||||
include::../errors/405.adoc[]
|
||||
include::../errors/406.adoc[]
|
||||
include::../errors/429.adoc[]
|
||||
|===
|
||||
|
||||
== Additional content
|
||||
|
||||
[[error-body]]
|
||||
=== Error body
|
||||
|
||||
include::../errors/error-response-body.adoc[]
|
||||
3
hawkbit-rest/hawkbit-rest-docs/src/main/errors/400.adoc
Normal file
3
hawkbit-rest/hawkbit-rest-docs/src/main/errors/400.adoc
Normal file
@@ -0,0 +1,3 @@
|
||||
| `400 Bad Request`
|
||||
| Bad Request - e.g. invalid parameters
|
||||
|
|
||||
3
hawkbit-rest/hawkbit-rest-docs/src/main/errors/401.adoc
Normal file
3
hawkbit-rest/hawkbit-rest-docs/src/main/errors/401.adoc
Normal file
@@ -0,0 +1,3 @@
|
||||
| `401 Unauthorized`
|
||||
| The request requires user authentication.
|
||||
|
|
||||
3
hawkbit-rest/hawkbit-rest-docs/src/main/errors/403.adoc
Normal file
3
hawkbit-rest/hawkbit-rest-docs/src/main/errors/403.adoc
Normal file
@@ -0,0 +1,3 @@
|
||||
| `403 Forbidden`
|
||||
| Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.
|
||||
| See <<error-body>>
|
||||
@@ -0,0 +1,3 @@
|
||||
| `403 Forbidden`
|
||||
| Insufficient permissions, data volume restriction applies or quota limit exceeded.
|
||||
| See <<error-body>>
|
||||
3
hawkbit-rest/hawkbit-rest-docs/src/main/errors/404.adoc
Normal file
3
hawkbit-rest/hawkbit-rest-docs/src/main/errors/404.adoc
Normal file
@@ -0,0 +1,3 @@
|
||||
| `404 Not Found`
|
||||
| Not Found Target.
|
||||
| See <<error-body>>
|
||||
3
hawkbit-rest/hawkbit-rest-docs/src/main/errors/405.adoc
Normal file
3
hawkbit-rest/hawkbit-rest-docs/src/main/errors/405.adoc
Normal file
@@ -0,0 +1,3 @@
|
||||
| `405 Method Not Allowed`
|
||||
| The http request method is not allowed on the resource.
|
||||
|
|
||||
3
hawkbit-rest/hawkbit-rest-docs/src/main/errors/406.adoc
Normal file
3
hawkbit-rest/hawkbit-rest-docs/src/main/errors/406.adoc
Normal file
@@ -0,0 +1,3 @@
|
||||
| `406 Not Acceptable`
|
||||
| In case accept header is specified and not application/json.
|
||||
|
|
||||
3
hawkbit-rest/hawkbit-rest-docs/src/main/errors/409.adoc
Normal file
3
hawkbit-rest/hawkbit-rest-docs/src/main/errors/409.adoc
Normal file
@@ -0,0 +1,3 @@
|
||||
| `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>>
|
||||
3
hawkbit-rest/hawkbit-rest-docs/src/main/errors/415.adoc
Normal file
3
hawkbit-rest/hawkbit-rest-docs/src/main/errors/415.adoc
Normal file
@@ -0,0 +1,3 @@
|
||||
| `415 Unsupported Media Type`
|
||||
| The request was attempt with a media-type which is not supported by the server for this resource.
|
||||
|
|
||||
3
hawkbit-rest/hawkbit-rest-docs/src/main/errors/429.adoc
Normal file
3
hawkbit-rest/hawkbit-rest-docs/src/main/errors/429.adoc
Normal file
@@ -0,0 +1,3 @@
|
||||
| `429 Too Many Request`
|
||||
| Too many requests. The server will refuse further attempts and the client has to wait another second.
|
||||
|
|
||||
@@ -0,0 +1,27 @@
|
||||
[source,http]
|
||||
----
|
||||
|
||||
{
|
||||
"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
|
||||
|===
|
||||
@@ -0,0 +1,64 @@
|
||||
= Management API
|
||||
Eclipse hawkBit;
|
||||
:doctype: book
|
||||
:icons: font
|
||||
:source-highlighter: highlightjs
|
||||
:toc: macro
|
||||
:toclevels: 1
|
||||
:sectlinks:
|
||||
:linkattrs:
|
||||
|
||||
[[resource-name]]
|
||||
= Resource name
|
||||
|
||||
toc::[]
|
||||
|
||||
|
||||
== The request: Example: GET /rest/v1/targets
|
||||
|
||||
=== Implementation notes
|
||||
|
||||
..... Implementation notes .....
|
||||
..... Implementation notes .....
|
||||
|
||||
=== Describe the request: Example: Get paged list of targets
|
||||
|
||||
==== CURL
|
||||
|
||||
include::{snippets}/ ... ...curl-request.adoc[]
|
||||
|
||||
==== Request URL
|
||||
|
||||
include::{snippets}/... ...http-request.adoc[]
|
||||
|
||||
==== Request path parameter
|
||||
|
||||
include::{snippets}/ ... ...path-parameters.adoc[]
|
||||
|
||||
==== Request fields
|
||||
|
||||
include::{snippets}/ ... ...request-fields.adoc[]
|
||||
|
||||
==== Request query parameter
|
||||
|
||||
include::{snippets}/ ... ...with-parameters/request-parameters.adoc[]
|
||||
|
||||
==== Request parameter example
|
||||
|
||||
include::{snippets}/ ... ...with-parameters/http-request.adoc[]
|
||||
|
||||
=== Response (Status 200)
|
||||
|
||||
==== Response fields
|
||||
|
||||
include::{snippets}/ ... ...response-fields.adoc[]
|
||||
|
||||
==== Response example
|
||||
|
||||
include::{snippets}/ ... ...http-response.adoc[]
|
||||
|
||||
=== Error responses
|
||||
|
||||
include::../errors/...
|
||||
include::../errors/...
|
||||
...
|
||||
Reference in New Issue
Block a user