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



