* actions.cleanup.onQuotaHit.percent -> action.cleanup.onQuotaHit.percent * action.cleanup.enabled - removed - instead enabled / disable <=> expire < / >= 0 * action.cleanup.actionExpiry -> action.cleanup.auto.expiry and action.cleanup.auto.status - so both are under action.cleanup.auto, and differentiate from on quota hit * auto db convert of props with one backward incompatibility - if you had action.cleanup.enabled=true and not set action.cleanup.actionExpiry (assuming default 30 days) - auto cleanup will be disabled you should set action.cleanup.auto.expiry=2592000000 in order to get the old behavior * Note that if you have configured global action cleanup the properties are changed also this config you shall change manually Signed-off-by: Avgustin Marinov <Avgustin.Marinov@bosch.com>
3928 lines
2.4 MiB
3928 lines
2.4 MiB
<!--
|
||
Copyright (c) 2025 Contributors to the Eclipse Foundation
|
||
|
||
This program and the accompanying materials are made
|
||
available under the terms of the Eclipse Public License 2.0
|
||
which is available at https://www.eclipse.org/legal/epl-2.0/
|
||
|
||
SPDX-License-Identifier: EPL-2.0
|
||
-->
|
||
|
||
<!DOCTYPE html>
|
||
<html>
|
||
|
||
<head>
|
||
<meta charset="utf8" />
|
||
<title>hawkBit REST APIs</title>
|
||
<!-- needed for adaptive design -->
|
||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
<style>
|
||
body {
|
||
padding: 0;
|
||
margin: 0;
|
||
}
|
||
</style>
|
||
<script src="https://cdn.redoc.ly/redoc/v2.1.3/bundles/redoc.standalone.js"></script><style data-styled="true" data-styled-version="6.1.8">.gikxZY{width:calc(100% - 40%);padding:0 40px;}/*!sc*/
|
||
@media print,screen and (max-width: 75rem){.gikxZY{width:100%;padding:40px 40px;}}/*!sc*/
|
||
.jSgyLg{width:calc(100% - 40%);padding:0 40px;}/*!sc*/
|
||
@media print,screen and (max-width: 75rem){.jSgyLg{width:100%;padding:0px 40px;}}/*!sc*/
|
||
data-styled.g4[id="sc-hLQSwg"]{content:"gikxZY,jSgyLg,"}/*!sc*/
|
||
.hNzKJC{padding:40px 0;}/*!sc*/
|
||
.hNzKJC:last-child{min-height:calc(100vh + 1px);}/*!sc*/
|
||
.hNzKJC>.hNzKJC:last-child{min-height:initial;}/*!sc*/
|
||
@media print,screen and (max-width: 75rem){.hNzKJC{padding:0;}}/*!sc*/
|
||
.cSNAXN{padding:40px 0;position:relative;}/*!sc*/
|
||
.cSNAXN:last-child{min-height:calc(100vh + 1px);}/*!sc*/
|
||
.cSNAXN>.cSNAXN:last-child{min-height:initial;}/*!sc*/
|
||
@media print,screen and (max-width: 75rem){.cSNAXN{padding:0;}}/*!sc*/
|
||
.cSNAXN:not(:last-of-type):after{position:absolute;bottom:0;width:100%;display:block;content:'';border-bottom:1px solid rgba(0, 0, 0, 0.2);}/*!sc*/
|
||
data-styled.g5[id="sc-eDLKkx"]{content:"hNzKJC,cSNAXN,"}/*!sc*/
|
||
.imiXRU{width:40%;color:#ffffff;background-color:#263238;padding:0 40px;}/*!sc*/
|
||
@media print,screen and (max-width: 75rem){.imiXRU{width:100%;padding:40px 40px;}}/*!sc*/
|
||
data-styled.g6[id="sc-jTQCzO"]{content:"imiXRU,"}/*!sc*/
|
||
.jGdkPR{background-color:#263238;}/*!sc*/
|
||
data-styled.g7[id="sc-gLLuof"]{content:"jGdkPR,"}/*!sc*/
|
||
.fsPUig{display:flex;width:100%;padding:0;}/*!sc*/
|
||
@media print,screen and (max-width: 75rem){.fsPUig{flex-direction:column;}}/*!sc*/
|
||
data-styled.g8[id="sc-iBdnpw"]{content:"fsPUig,"}/*!sc*/
|
||
.gqLiaw{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.85714em;line-height:1.6em;color:#333333;}/*!sc*/
|
||
data-styled.g9[id="sc-fsYfdN"]{content:"gqLiaw,"}/*!sc*/
|
||
.gwJLUj{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.57143em;line-height:1.6em;color:#333333;margin:0 0 20px;}/*!sc*/
|
||
data-styled.g10[id="sc-qZrbh"]{content:"gwJLUj,"}/*!sc*/
|
||
.klfnyk{color:#ffffff;}/*!sc*/
|
||
data-styled.g12[id="sc-kFCroH"]{content:"klfnyk,"}/*!sc*/
|
||
.cnGhhy{border-bottom:1px solid rgba(38, 50, 56, 0.3);margin:1em 0 1em 0;color:rgba(38, 50, 56, 0.5);font-weight:normal;text-transform:uppercase;font-size:0.929em;line-height:20px;}/*!sc*/
|
||
data-styled.g13[id="sc-irLvIq"]{content:"cnGhhy,"}/*!sc*/
|
||
.fNhImz{cursor:pointer;margin-left:-20px;padding:0;line-height:1;width:20px;display:inline-block;outline:0;}/*!sc*/
|
||
.fNhImz:before{content:'';width:15px;height:15px;background-size:contain;background-image:url('data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZlcnNpb249IjEuMSIgeD0iMCIgeT0iMCIgd2lkdGg9IjUxMiIgaGVpZ2h0PSI1MTIiIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBlbmFibGUtYmFja2dyb3VuZD0ibmV3IDAgMCA1MTIgNTEyIiB4bWw6c3BhY2U9InByZXNlcnZlIj48cGF0aCBmaWxsPSIjMDEwMTAxIiBkPSJNNDU5LjcgMjMzLjRsLTkwLjUgOTAuNWMtNTAgNTAtMTMxIDUwLTE4MSAwIC03LjktNy44LTE0LTE2LjctMTkuNC0yNS44bDQyLjEtNDIuMWMyLTIgNC41LTMuMiA2LjgtNC41IDIuOSA5LjkgOCAxOS4zIDE1LjggMjcuMiAyNSAyNSA2NS42IDI0LjkgOTAuNSAwbDkwLjUtOTAuNWMyNS0yNSAyNS02NS42IDAtOTAuNSAtMjQuOS0yNS02NS41LTI1LTkwLjUgMGwtMzIuMiAzMi4yYy0yNi4xLTEwLjItNTQuMi0xMi45LTgxLjYtOC45bDY4LjYtNjguNmM1MC01MCAxMzEtNTAgMTgxIDBDNTA5LjYgMTAyLjMgNTA5LjYgMTgzLjQgNDU5LjcgMjMzLjR6TTIyMC4zIDM4Mi4ybC0zMi4yIDMyLjJjLTI1IDI0LjktNjUuNiAyNC45LTkwLjUgMCAtMjUtMjUtMjUtNjUuNiAwLTkwLjVsOTAuNS05MC41YzI1LTI1IDY1LjUtMjUgOTAuNSAwIDcuOCA3LjggMTIuOSAxNy4yIDE1LjggMjcuMSAyLjQtMS40IDQuOC0yLjUgNi44LTQuNWw0Mi4xLTQyYy01LjQtOS4yLTExLjYtMTgtMTkuNC0yNS44IC01MC01MC0xMzEtNTAtMTgxIDBsLTkwLjUgOTAuNWMtNTAgNTAtNTAgMTMxIDAgMTgxIDUwIDUwIDEzMSA1MCAxODEgMGw2OC42LTY4LjZDMjc0LjYgMzk1LjEgMjQ2LjQgMzkyLjMgMjIwLjMgMzgyLjJ6Ii8+PC9zdmc+Cg==');opacity:0.5;visibility:hidden;display:inline-block;vertical-align:middle;}/*!sc*/
|
||
h1:hover>.fNhImz::before,h2:hover>.fNhImz::before,.fNhImz:hover::before{visibility:visible;}/*!sc*/
|
||
data-styled.g14[id="sc-csKJxZ"]{content:"fNhImz,"}/*!sc*/
|
||
.gEokXu{height:18px;width:18px;min-width:18px;vertical-align:middle;float:right;transition:transform 0.2s ease-out;transform:rotateZ(-90deg);}/*!sc*/
|
||
.hUWsvg{height:1.5em;width:1.5em;min-width:1.5em;vertical-align:middle;float:left;transition:transform 0.2s ease-out;transform:rotateZ(-90deg);}/*!sc*/
|
||
.hUWsvg polygon{fill:#1d8127;}/*!sc*/
|
||
.fWTllA{height:1.5em;width:1.5em;min-width:1.5em;vertical-align:middle;float:left;transition:transform 0.2s ease-out;transform:rotateZ(-90deg);}/*!sc*/
|
||
.fWTllA polygon{fill:#d41f1c;}/*!sc*/
|
||
.exoGJA{height:20px;width:20px;min-width:20px;vertical-align:middle;float:right;transition:transform 0.2s ease-out;transform:rotateZ(0);}/*!sc*/
|
||
.exoGJA polygon{fill:white;}/*!sc*/
|
||
.jIsRbK{height:18px;width:18px;min-width:18px;vertical-align:middle;transition:transform 0.2s ease-out;transform:rotateZ(-90deg);}/*!sc*/
|
||
data-styled.g15[id="sc-eTNRI"]{content:"gEokXu,hUWsvg,fWTllA,exoGJA,jIsRbK,"}/*!sc*/
|
||
.cqoAxn{border-left:1px solid #7c7cbb;box-sizing:border-box;position:relative;padding:10px 10px 10px 0;}/*!sc*/
|
||
@media screen and (max-width: 50rem){.cqoAxn{display:block;overflow:hidden;}}/*!sc*/
|
||
tr:first-of-type>.cqoAxn,tr.last>.cqoAxn{border-left-width:0;background-position:top left;background-repeat:no-repeat;background-size:1px 100%;}/*!sc*/
|
||
tr:first-of-type>.cqoAxn{background-image:linear-gradient(
|
||
to bottom,
|
||
transparent 0%,
|
||
transparent 22px,
|
||
#7c7cbb 22px,
|
||
#7c7cbb 100%
|
||
);}/*!sc*/
|
||
tr.last>.cqoAxn{background-image:linear-gradient(
|
||
to bottom,
|
||
#7c7cbb 0%,
|
||
#7c7cbb 22px,
|
||
transparent 22px,
|
||
transparent 100%
|
||
);}/*!sc*/
|
||
tr.last+tr>.cqoAxn{border-left-color:transparent;}/*!sc*/
|
||
tr.last:first-child>.cqoAxn{background:none;border-left-color:transparent;}/*!sc*/
|
||
data-styled.g18[id="sc-hABBmJ"]{content:"cqoAxn,"}/*!sc*/
|
||
.hfWKVF{vertical-align:top;line-height:20px;white-space:nowrap;font-size:13px;font-family:Courier,monospace;}/*!sc*/
|
||
.hfWKVF.deprecated{text-decoration:line-through;color:#707070;}/*!sc*/
|
||
data-styled.g20[id="sc-fHejqy"]{content:"hfWKVF,"}/*!sc*/
|
||
.berbbf{border-bottom:1px solid #9fb4be;padding:10px 0;width:75%;box-sizing:border-box;}/*!sc*/
|
||
tr.expanded .berbbf{border-bottom:none;}/*!sc*/
|
||
@media screen and (max-width: 50rem){.berbbf{padding:0 20px;border-bottom:none;border-left:1px solid #7c7cbb;}tr.last>.berbbf{border-left:none;}}/*!sc*/
|
||
data-styled.g21[id="sc-blmEgr"]{content:"berbbf,"}/*!sc*/
|
||
.hIHfpT{color:#7c7cbb;font-family:Courier,monospace;margin-right:10px;}/*!sc*/
|
||
.hIHfpT::before{content:'';display:inline-block;vertical-align:middle;width:10px;height:1px;background:#7c7cbb;}/*!sc*/
|
||
.hIHfpT::after{content:'';display:inline-block;vertical-align:middle;width:1px;background:#7c7cbb;height:7px;}/*!sc*/
|
||
data-styled.g22[id="sc-ifyrAs"]{content:"hIHfpT,"}/*!sc*/
|
||
.kHkWhD{border-collapse:separate;border-radius:3px;font-size:14px;border-spacing:0;width:100%;}/*!sc*/
|
||
.kHkWhD >tr{vertical-align:middle;}/*!sc*/
|
||
@media screen and (max-width: 50rem){.kHkWhD{display:block;}.kHkWhD >tr,.kHkWhD >tbody>tr{display:block;}}/*!sc*/
|
||
@media screen and (max-width: 50rem) and (-ms-high-contrast:none){.kHkWhD td{float:left;width:100%;}}/*!sc*/
|
||
.kHkWhD .sc-dJGMql,.kHkWhD .sc-dJGMql .sc-dJGMql .sc-dJGMql,.kHkWhD .sc-dJGMql .sc-dJGMql .sc-dJGMql .sc-dJGMql .sc-dJGMql{margin:1em;margin-right:0;background:#fafafa;}/*!sc*/
|
||
.kHkWhD .sc-dJGMql .sc-dJGMql,.kHkWhD .sc-dJGMql .sc-dJGMql .sc-dJGMql .sc-dJGMql,.kHkWhD .sc-dJGMql .sc-dJGMql .sc-dJGMql .sc-dJGMql .sc-dJGMql .sc-dJGMql{background:#ffffff;}/*!sc*/
|
||
data-styled.g24[id="sc-hIPBNq"]{content:"kHkWhD,"}/*!sc*/
|
||
.cplVKI{font-size:0.9em;font-family:Courier,monospace;}/*!sc*/
|
||
.cplVKI::after{content:' [';}/*!sc*/
|
||
data-styled.g28[id="sc-bBkKde"]{content:"cplVKI,"}/*!sc*/
|
||
.hPMvVd{font-size:0.9em;font-family:Courier,monospace;}/*!sc*/
|
||
.hPMvVd::after{content:']';}/*!sc*/
|
||
data-styled.g29[id="sc-iuOOrT"]{content:"hPMvVd,"}/*!sc*/
|
||
.jSWvqu >ul{list-style:none;padding:0;margin:0;margin:0 -5px;}/*!sc*/
|
||
.jSWvqu >ul >li{padding:5px 10px;display:inline-block;background-color:#11171a;border-bottom:1px solid rgba(0, 0, 0, 0.5);cursor:pointer;text-align:center;outline:none;color:#ccc;margin:0 5px 5px 5px;border:1px solid #07090b;border-radius:5px;min-width:60px;font-size:0.9em;font-weight:bold;}/*!sc*/
|
||
.jSWvqu >ul >li.react-tabs__tab--selected{color:#333333;background:#ffffff;}/*!sc*/
|
||
.jSWvqu >ul >li.react-tabs__tab--selected:focus{outline:auto;}/*!sc*/
|
||
.jSWvqu >ul >li:only-child{flex:none;min-width:100px;}/*!sc*/
|
||
.jSWvqu >ul >li.tab-success{color:#1d8127;}/*!sc*/
|
||
.jSWvqu >ul >li.tab-redirect{color:#ffa500;}/*!sc*/
|
||
.jSWvqu >ul >li.tab-info{color:#87ceeb;}/*!sc*/
|
||
.jSWvqu >ul >li.tab-error{color:#d41f1c;}/*!sc*/
|
||
.jSWvqu >.react-tabs__tab-panel{background:#11171a;}/*!sc*/
|
||
.jSWvqu >.react-tabs__tab-panel>div,.jSWvqu >.react-tabs__tab-panel>pre{padding:20px;margin:0;}/*!sc*/
|
||
.jSWvqu >.react-tabs__tab-panel>div>pre{padding:0;}/*!sc*/
|
||
data-styled.g30[id="sc-cyZbeP"]{content:"jSWvqu,"}/*!sc*/
|
||
.WVNwY code[class*='language-'],.WVNwY pre[class*='language-']{text-shadow:0 -0.1em 0.2em black;text-align:left;white-space:pre;word-spacing:normal;word-break:normal;word-wrap:normal;line-height:1.5;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-hyphens:none;-moz-hyphens:none;-ms-hyphens:none;hyphens:none;}/*!sc*/
|
||
@media print{.WVNwY code[class*='language-'],.WVNwY pre[class*='language-']{text-shadow:none;}}/*!sc*/
|
||
.WVNwY pre[class*='language-']{padding:1em;margin:0.5em 0;overflow:auto;}/*!sc*/
|
||
.WVNwY .token.comment,.WVNwY .token.prolog,.WVNwY .token.doctype,.WVNwY .token.cdata{color:hsl(30, 20%, 50%);}/*!sc*/
|
||
.WVNwY .token.punctuation{opacity:0.7;}/*!sc*/
|
||
.WVNwY .namespace{opacity:0.7;}/*!sc*/
|
||
.WVNwY .token.property,.WVNwY .token.tag,.WVNwY .token.number,.WVNwY .token.constant,.WVNwY .token.symbol{color:#4a8bb3;}/*!sc*/
|
||
.WVNwY .token.boolean{color:#e64441;}/*!sc*/
|
||
.WVNwY .token.selector,.WVNwY .token.attr-name,.WVNwY .token.string,.WVNwY .token.char,.WVNwY .token.builtin,.WVNwY .token.inserted{color:#a0fbaa;}/*!sc*/
|
||
.WVNwY .token.selector+a,.WVNwY .token.attr-name+a,.WVNwY .token.string+a,.WVNwY .token.char+a,.WVNwY .token.builtin+a,.WVNwY .token.inserted+a,.WVNwY .token.selector+a:visited,.WVNwY .token.attr-name+a:visited,.WVNwY .token.string+a:visited,.WVNwY .token.char+a:visited,.WVNwY .token.builtin+a:visited,.WVNwY .token.inserted+a:visited{color:#4ed2ba;text-decoration:underline;}/*!sc*/
|
||
.WVNwY .token.property.string{color:white;}/*!sc*/
|
||
.WVNwY .token.operator,.WVNwY .token.entity,.WVNwY .token.url,.WVNwY .token.variable{color:hsl(40, 90%, 60%);}/*!sc*/
|
||
.WVNwY .token.atrule,.WVNwY .token.attr-value,.WVNwY .token.keyword{color:hsl(350, 40%, 70%);}/*!sc*/
|
||
.WVNwY .token.regex,.WVNwY .token.important{color:#e90;}/*!sc*/
|
||
.WVNwY .token.important,.WVNwY .token.bold{font-weight:bold;}/*!sc*/
|
||
.WVNwY .token.italic{font-style:italic;}/*!sc*/
|
||
.WVNwY .token.entity{cursor:help;}/*!sc*/
|
||
.WVNwY .token.deleted{color:red;}/*!sc*/
|
||
data-styled.g32[id="sc-iKOmoZ"]{content:"WVNwY,"}/*!sc*/
|
||
.iwAAMv{opacity:0.7;transition:opacity 0.3s ease;text-align:right;}/*!sc*/
|
||
.iwAAMv:focus-within{opacity:1;}/*!sc*/
|
||
.iwAAMv >button{background-color:transparent;border:0;color:inherit;padding:2px 10px;font-family:Roboto,sans-serif;font-size:14px;line-height:1.5em;cursor:pointer;outline:0;}/*!sc*/
|
||
.iwAAMv >button :hover,.iwAAMv >button :focus{background:rgba(255, 255, 255, 0.1);}/*!sc*/
|
||
data-styled.g33[id="sc-gjLLEI"]{content:"iwAAMv,"}/*!sc*/
|
||
.kIqtpW{position:relative;}/*!sc*/
|
||
data-styled.g37[id="sc-kMzELR"]{content:"kIqtpW,"}/*!sc*/
|
||
.hNiGMc{position:absolute;pointer-events:none;z-index:1;top:50%;-webkit-transform:translateY(-50%);-ms-transform:translateY(-50%);transform:translateY(-50%);right:8px;margin:auto;text-align:center;}/*!sc*/
|
||
.hNiGMc polyline{color:white;}/*!sc*/
|
||
.bCxWCn{position:absolute;pointer-events:none;z-index:1;top:50%;-webkit-transform:translateY(-50%);-ms-transform:translateY(-50%);transform:translateY(-50%);right:8px;margin:auto;text-align:center;}/*!sc*/
|
||
data-styled.g38[id="sc-ilxebA"]{content:"hNiGMc,bCxWCn,"}/*!sc*/
|
||
.bjIddV{box-sizing:border-box;min-width:100px;outline:none;display:inline-block;border-radius:2px;border:1px solid rgba(38, 50, 56, 0.5);vertical-align:bottom;padding:2px 0px 2px 6px;position:relative;width:auto;background:white;color:#263238;font-family:Montserrat,sans-serif;font-size:0.929em;line-height:1.5em;cursor:pointer;transition:border 0.25s ease,color 0.25s ease,box-shadow 0.25s ease;}/*!sc*/
|
||
.bjIddV label{box-sizing:border-box;min-width:100px;outline:none;display:inline-block;font-family:Montserrat,sans-serif;color:#333333;vertical-align:bottom;width:auto;text-transform:none;padding:0 22px 0 4px;font-size:0.929em;line-height:1.5em;font-family:inherit;text-overflow:ellipsis;overflow:hidden;white-space:nowrap;}/*!sc*/
|
||
.bjIddV .dropdown-select{position:absolute;top:0;left:0;width:100%;height:100%;opacity:0;border:none;appearance:none;cursor:pointer;color:#333333;line-height:inherit;font-family:inherit;}/*!sc*/
|
||
.bjIddV:hover,.bjIddV:focus-within{border:1px solid #32329f;color:#32329f;box-shadow:0px 0px 0px 1px #32329f;}/*!sc*/
|
||
data-styled.g39[id="sc-jIBlqr"]{content:"bjIddV,"}/*!sc*/
|
||
.lkwvLJ{margin-left:10px;text-transform:none;font-size:0.969em;font-size:1em;border:none;padding:0 1.2em 0 0;background:transparent;}/*!sc*/
|
||
.lkwvLJ:hover,.lkwvLJ:focus-within{border:none;box-shadow:none;}/*!sc*/
|
||
.lkwvLJ:hover label,.lkwvLJ:focus-within label{color:#32329f;text-shadow:0px 0px 0px #32329f;}/*!sc*/
|
||
data-styled.g40[id="sc-hhyKGa"]{content:"lkwvLJ,"}/*!sc*/
|
||
.hJSqDi{margin-left:10px;text-transform:none;font-size:0.929em;color:black;}/*!sc*/
|
||
data-styled.g41[id="sc-gYrqIg"]{content:"hJSqDi,"}/*!sc*/
|
||
.VEBGS{font-family:Roboto,sans-serif;font-weight:400;line-height:1.5em;}/*!sc*/
|
||
.VEBGS p:last-child{margin-bottom:0;}/*!sc*/
|
||
.VEBGS h1{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.85714em;line-height:1.6em;color:#32329f;margin-top:0;}/*!sc*/
|
||
.VEBGS h2{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.57143em;line-height:1.6em;color:#333333;}/*!sc*/
|
||
.VEBGS code{color:#e53935;background-color:rgba(38, 50, 56, 0.05);font-family:Courier,monospace;border-radius:2px;border:1px solid rgba(38, 50, 56, 0.1);padding:0 5px;font-size:13px;font-weight:400;word-break:break-word;}/*!sc*/
|
||
.VEBGS pre{font-family:Courier,monospace;white-space:pre;background-color:#11171a;color:white;padding:20px;overflow-x:auto;line-height:normal;border-radius:0;border:1px solid rgba(38, 50, 56, 0.1);}/*!sc*/
|
||
.VEBGS pre code{background-color:transparent;color:white;padding:0;}/*!sc*/
|
||
.VEBGS pre code:before,.VEBGS pre code:after{content:none;}/*!sc*/
|
||
.VEBGS blockquote{margin:0;margin-bottom:1em;padding:0 15px;color:#777;border-left:4px solid #ddd;}/*!sc*/
|
||
.VEBGS img{max-width:100%;box-sizing:content-box;}/*!sc*/
|
||
.VEBGS ul,.VEBGS ol{padding-left:2em;margin:0;margin-bottom:1em;}/*!sc*/
|
||
.VEBGS ul ul,.VEBGS ol ul,.VEBGS ul ol,.VEBGS ol ol{margin-bottom:0;margin-top:0;}/*!sc*/
|
||
.VEBGS table{display:block;width:100%;overflow:auto;word-break:normal;word-break:keep-all;border-collapse:collapse;border-spacing:0;margin-top:1.5em;margin-bottom:1.5em;}/*!sc*/
|
||
.VEBGS table tr{background-color:#fff;border-top:1px solid #ccc;}/*!sc*/
|
||
.VEBGS table tr:nth-child(2n){background-color:#fafafa;}/*!sc*/
|
||
.VEBGS table th,.VEBGS table td{padding:6px 13px;border:1px solid #ddd;}/*!sc*/
|
||
.VEBGS table th{text-align:left;font-weight:bold;}/*!sc*/
|
||
.VEBGS .share-link{cursor:pointer;margin-left:-20px;padding:0;line-height:1;width:20px;display:inline-block;outline:0;}/*!sc*/
|
||
.VEBGS .share-link:before{content:'';width:15px;height:15px;background-size:contain;background-image:url('data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZlcnNpb249IjEuMSIgeD0iMCIgeT0iMCIgd2lkdGg9IjUxMiIgaGVpZ2h0PSI1MTIiIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBlbmFibGUtYmFja2dyb3VuZD0ibmV3IDAgMCA1MTIgNTEyIiB4bWw6c3BhY2U9InByZXNlcnZlIj48cGF0aCBmaWxsPSIjMDEwMTAxIiBkPSJNNDU5LjcgMjMzLjRsLTkwLjUgOTAuNWMtNTAgNTAtMTMxIDUwLTE4MSAwIC03LjktNy44LTE0LTE2LjctMTkuNC0yNS44bDQyLjEtNDIuMWMyLTIgNC41LTMuMiA2LjgtNC41IDIuOSA5LjkgOCAxOS4zIDE1LjggMjcuMiAyNSAyNSA2NS42IDI0LjkgOTAuNSAwbDkwLjUtOTAuNWMyNS0yNSAyNS02NS42IDAtOTAuNSAtMjQuOS0yNS02NS41LTI1LTkwLjUgMGwtMzIuMiAzMi4yYy0yNi4xLTEwLjItNTQuMi0xMi45LTgxLjYtOC45bDY4LjYtNjguNmM1MC01MCAxMzEtNTAgMTgxIDBDNTA5LjYgMTAyLjMgNTA5LjYgMTgzLjQgNDU5LjcgMjMzLjR6TTIyMC4zIDM4Mi4ybC0zMi4yIDMyLjJjLTI1IDI0LjktNjUuNiAyNC45LTkwLjUgMCAtMjUtMjUtMjUtNjUuNiAwLTkwLjVsOTAuNS05MC41YzI1LTI1IDY1LjUtMjUgOTAuNSAwIDcuOCA3LjggMTIuOSAxNy4yIDE1LjggMjcuMSAyLjQtMS40IDQuOC0yLjUgNi44LTQuNWw0Mi4xLTQyYy01LjQtOS4yLTExLjYtMTgtMTkuNC0yNS44IC01MC01MC0xMzEtNTAtMTgxIDBsLTkwLjUgOTAuNWMtNTAgNTAtNTAgMTMxIDAgMTgxIDUwIDUwIDEzMSA1MCAxODEgMGw2OC42LTY4LjZDMjc0LjYgMzk1LjEgMjQ2LjQgMzkyLjMgMjIwLjMgMzgyLjJ6Ii8+PC9zdmc+Cg==');opacity:0.5;visibility:hidden;display:inline-block;vertical-align:middle;}/*!sc*/
|
||
.VEBGS h1:hover>.share-link::before,.VEBGS h2:hover>.share-link::before,.VEBGS .share-link:hover::before{visibility:visible;}/*!sc*/
|
||
.VEBGS a{text-decoration:auto;color:#32329f;}/*!sc*/
|
||
.VEBGS a:visited{color:#32329f;}/*!sc*/
|
||
.VEBGS a:hover{color:#6868cf;text-decoration:auto;}/*!sc*/
|
||
.jaVotg{font-family:Roboto,sans-serif;font-weight:400;line-height:1.5em;}/*!sc*/
|
||
.jaVotg p:last-child{margin-bottom:0;}/*!sc*/
|
||
.jaVotg p:first-child{margin-top:0;}/*!sc*/
|
||
.jaVotg p:last-child{margin-bottom:0;}/*!sc*/
|
||
.jaVotg h1{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.85714em;line-height:1.6em;color:#32329f;margin-top:0;}/*!sc*/
|
||
.jaVotg h2{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.57143em;line-height:1.6em;color:#333333;}/*!sc*/
|
||
.jaVotg code{color:#e53935;background-color:rgba(38, 50, 56, 0.05);font-family:Courier,monospace;border-radius:2px;border:1px solid rgba(38, 50, 56, 0.1);padding:0 5px;font-size:13px;font-weight:400;word-break:break-word;}/*!sc*/
|
||
.jaVotg pre{font-family:Courier,monospace;white-space:pre;background-color:#11171a;color:white;padding:20px;overflow-x:auto;line-height:normal;border-radius:0;border:1px solid rgba(38, 50, 56, 0.1);}/*!sc*/
|
||
.jaVotg pre code{background-color:transparent;color:white;padding:0;}/*!sc*/
|
||
.jaVotg pre code:before,.jaVotg pre code:after{content:none;}/*!sc*/
|
||
.jaVotg blockquote{margin:0;margin-bottom:1em;padding:0 15px;color:#777;border-left:4px solid #ddd;}/*!sc*/
|
||
.jaVotg img{max-width:100%;box-sizing:content-box;}/*!sc*/
|
||
.jaVotg ul,.jaVotg ol{padding-left:2em;margin:0;margin-bottom:1em;}/*!sc*/
|
||
.jaVotg ul ul,.jaVotg ol ul,.jaVotg ul ol,.jaVotg ol ol{margin-bottom:0;margin-top:0;}/*!sc*/
|
||
.jaVotg table{display:block;width:100%;overflow:auto;word-break:normal;word-break:keep-all;border-collapse:collapse;border-spacing:0;margin-top:1.5em;margin-bottom:1.5em;}/*!sc*/
|
||
.jaVotg table tr{background-color:#fff;border-top:1px solid #ccc;}/*!sc*/
|
||
.jaVotg table tr:nth-child(2n){background-color:#fafafa;}/*!sc*/
|
||
.jaVotg table th,.jaVotg table td{padding:6px 13px;border:1px solid #ddd;}/*!sc*/
|
||
.jaVotg table th{text-align:left;font-weight:bold;}/*!sc*/
|
||
.jaVotg .share-link{cursor:pointer;margin-left:-20px;padding:0;line-height:1;width:20px;display:inline-block;outline:0;}/*!sc*/
|
||
.jaVotg .share-link:before{content:'';width:15px;height:15px;background-size:contain;background-image:url('data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZlcnNpb249IjEuMSIgeD0iMCIgeT0iMCIgd2lkdGg9IjUxMiIgaGVpZ2h0PSI1MTIiIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBlbmFibGUtYmFja2dyb3VuZD0ibmV3IDAgMCA1MTIgNTEyIiB4bWw6c3BhY2U9InByZXNlcnZlIj48cGF0aCBmaWxsPSIjMDEwMTAxIiBkPSJNNDU5LjcgMjMzLjRsLTkwLjUgOTAuNWMtNTAgNTAtMTMxIDUwLTE4MSAwIC03LjktNy44LTE0LTE2LjctMTkuNC0yNS44bDQyLjEtNDIuMWMyLTIgNC41LTMuMiA2LjgtNC41IDIuOSA5LjkgOCAxOS4zIDE1LjggMjcuMiAyNSAyNSA2NS42IDI0LjkgOTAuNSAwbDkwLjUtOTAuNWMyNS0yNSAyNS02NS42IDAtOTAuNSAtMjQuOS0yNS02NS41LTI1LTkwLjUgMGwtMzIuMiAzMi4yYy0yNi4xLTEwLjItNTQuMi0xMi45LTgxLjYtOC45bDY4LjYtNjguNmM1MC01MCAxMzEtNTAgMTgxIDBDNTA5LjYgMTAyLjMgNTA5LjYgMTgzLjQgNDU5LjcgMjMzLjR6TTIyMC4zIDM4Mi4ybC0zMi4yIDMyLjJjLTI1IDI0LjktNjUuNiAyNC45LTkwLjUgMCAtMjUtMjUtMjUtNjUuNiAwLTkwLjVsOTAuNS05MC41YzI1LTI1IDY1LjUtMjUgOTAuNSAwIDcuOCA3LjggMTIuOSAxNy4yIDE1LjggMjcuMSAyLjQtMS40IDQuOC0yLjUgNi44LTQuNWw0Mi4xLTQyYy01LjQtOS4yLTExLjYtMTgtMTkuNC0yNS44IC01MC01MC0xMzEtNTAtMTgxIDBsLTkwLjUgOTAuNWMtNTAgNTAtNTAgMTMxIDAgMTgxIDUwIDUwIDEzMSA1MCAxODEgMGw2OC42LTY4LjZDMjc0LjYgMzk1LjEgMjQ2LjQgMzkyLjMgMjIwLjMgMzgyLjJ6Ii8+PC9zdmc+Cg==');opacity:0.5;visibility:hidden;display:inline-block;vertical-align:middle;}/*!sc*/
|
||
.jaVotg h1:hover>.share-link::before,.jaVotg h2:hover>.share-link::before,.jaVotg .share-link:hover::before{visibility:visible;}/*!sc*/
|
||
.jaVotg a{text-decoration:auto;color:#32329f;}/*!sc*/
|
||
.jaVotg a:visited{color:#32329f;}/*!sc*/
|
||
.jaVotg a:hover{color:#6868cf;text-decoration:auto;}/*!sc*/
|
||
data-styled.g42[id="sc-cCzLxZ"]{content:"VEBGS,jaVotg,"}/*!sc*/
|
||
.LxEPk{display:inline;}/*!sc*/
|
||
data-styled.g43[id="sc-ckdEwu"]{content:"LxEPk,"}/*!sc*/
|
||
.krcPXE{position:relative;}/*!sc*/
|
||
data-styled.g44[id="sc-jdHILj"]{content:"krcPXE,"}/*!sc*/
|
||
.fOJBdW:hover>.sc-gjLLEI{opacity:1;}/*!sc*/
|
||
data-styled.g49[id="sc-cSxRuM"]{content:"fOJBdW,"}/*!sc*/
|
||
.DqFKH{font-family:Courier,monospace;font-size:13px;white-space:pre;contain:content;overflow-x:auto;}/*!sc*/
|
||
.DqFKH .redoc-json code>.collapser{display:none;pointer-events:none;}/*!sc*/
|
||
.DqFKH .callback-function{color:gray;}/*!sc*/
|
||
.DqFKH .collapser:after{content:'-';cursor:pointer;}/*!sc*/
|
||
.DqFKH .collapsed>.collapser:after{content:'+';cursor:pointer;}/*!sc*/
|
||
.DqFKH .ellipsis:after{content:' … ';}/*!sc*/
|
||
.DqFKH .collapsible{margin-left:2em;}/*!sc*/
|
||
.DqFKH .hoverable{padding-top:1px;padding-bottom:1px;padding-left:2px;padding-right:2px;border-radius:2px;}/*!sc*/
|
||
.DqFKH .hovered{background-color:rgba(235, 238, 249, 1);}/*!sc*/
|
||
.DqFKH .collapser{background-color:transparent;border:0;color:#fff;font-family:Courier,monospace;font-size:13px;padding-right:6px;padding-left:6px;padding-top:0;padding-bottom:0;display:flex;align-items:center;justify-content:center;width:15px;height:15px;position:absolute;top:4px;left:-1.5em;cursor:default;user-select:none;-webkit-user-select:none;padding:2px;}/*!sc*/
|
||
.DqFKH .collapser:focus{outline-color:#fff;outline-style:dotted;outline-width:1px;}/*!sc*/
|
||
.DqFKH ul{list-style-type:none;padding:0px;margin:0px 0px 0px 26px;}/*!sc*/
|
||
.DqFKH li{position:relative;display:block;}/*!sc*/
|
||
.DqFKH .hoverable{display:inline-block;}/*!sc*/
|
||
.DqFKH .selected{outline-style:solid;outline-width:1px;outline-style:dotted;}/*!sc*/
|
||
.DqFKH .collapsed>.collapsible{display:none;}/*!sc*/
|
||
.DqFKH .ellipsis{display:none;}/*!sc*/
|
||
.DqFKH .collapsed>.ellipsis{display:inherit;}/*!sc*/
|
||
data-styled.g50[id="sc-jMbVJB"]{content:"DqFKH,"}/*!sc*/
|
||
.jCmKdj{padding:0.9em;background-color:rgba(38,50,56,0.4);margin:0 0 10px 0;display:block;font-family:Montserrat,sans-serif;font-size:0.929em;line-height:1.5em;}/*!sc*/
|
||
data-styled.g51[id="sc-dQmiwx"]{content:"jCmKdj,"}/*!sc*/
|
||
.eTZsJr{font-family:Montserrat,sans-serif;font-size:12px;position:absolute;z-index:1;top:-11px;left:12px;font-weight:600;color:rgba(255,255,255,0.7);}/*!sc*/
|
||
data-styled.g52[id="sc-bCvmQg"]{content:"eTZsJr,"}/*!sc*/
|
||
.jBjImi{position:relative;}/*!sc*/
|
||
data-styled.g53[id="sc-cPtzlb"]{content:"jBjImi,"}/*!sc*/
|
||
.jyPEvF{margin:0 0 10px 0;display:block;background-color:rgba(38,50,56,0.4);border:none;padding:0.9em 1.6em 0.9em 0.9em;box-shadow:none;}/*!sc*/
|
||
.jyPEvF label{color:#ffffff;text-overflow:ellipsis;white-space:nowrap;overflow:hidden;font-size:1em;text-transform:none;border:none;}/*!sc*/
|
||
.jyPEvF:hover,.jyPEvF:focus-within{border:none;box-shadow:none;background-color:rgba(38,50,56,0.7);}/*!sc*/
|
||
data-styled.g54[id="sc-BCDEK"]{content:"jyPEvF,"}/*!sc*/
|
||
.jeLSWq{margin-top:15px;}/*!sc*/
|
||
data-styled.g56[id="sc-hVcFVo"]{content:"jeLSWq,"}/*!sc*/
|
||
.gIkRoy button{background-color:transparent;border:0;outline:0;font-size:13px;font-family:Courier,monospace;cursor:pointer;padding:0;color:#333333;}/*!sc*/
|
||
.gIkRoy button:focus{font-weight:600;}/*!sc*/
|
||
.gIkRoy .sc-eTNRI{height:1.1em;width:1.1em;}/*!sc*/
|
||
.gIkRoy .sc-eTNRI polygon{fill:#666;}/*!sc*/
|
||
data-styled.g57[id="sc-jiaSqj"]{content:"gIkRoy,"}/*!sc*/
|
||
.itHPsH{vertical-align:middle;font-size:13px;line-height:20px;}/*!sc*/
|
||
data-styled.g58[id="sc-gUjWJS"]{content:"itHPsH,"}/*!sc*/
|
||
.iSyacY{color:rgba(102,102,102,0.9);}/*!sc*/
|
||
data-styled.g59[id="sc-kZOsHZ"]{content:"iSyacY,"}/*!sc*/
|
||
.gfdSsP{color:#666;}/*!sc*/
|
||
data-styled.g60[id="sc-iLXxbI"]{content:"gfdSsP,"}/*!sc*/
|
||
.iUxudT{color:#666;word-break:break-word;}/*!sc*/
|
||
data-styled.g61[id="sc-jgraLO"]{content:"iUxudT,"}/*!sc*/
|
||
.ciWJhv{color:#d41f1c;font-size:0.9em;font-weight:normal;margin-left:20px;line-height:1;}/*!sc*/
|
||
data-styled.g62[id="sc-eKzvBH"]{content:"ciWJhv,"}/*!sc*/
|
||
.gwpJhW{color:#6868cf;}/*!sc*/
|
||
data-styled.g63[id="sc-ppzwM"]{content:"gwpJhW,"}/*!sc*/
|
||
.cRxwgg{border-radius:2px;word-break:break-word;background-color:rgba(51,51,51,0.05);color:rgba(51,51,51,0.9);padding:0 5px;border:1px solid rgba(51,51,51,0.1);font-family:Courier,monospace;}/*!sc*/
|
||
+{margin-left:0;}/*!sc*/
|
||
data-styled.g66[id="sc-ldgOGP"]{content:"cRxwgg,"}/*!sc*/
|
||
.iZgtJR{padding-left:10px;}/*!sc*/
|
||
data-styled.g75[id="sc-bbxCgr"]{content:"iZgtJR,"}/*!sc*/
|
||
.ObWVe{margin-top:0;margin-bottom:0.5em;}/*!sc*/
|
||
data-styled.g91[id="sc-eFyDpN"]{content:"ObWVe,"}/*!sc*/
|
||
.iGcmRf{border:1px solid #32329f;color:#32329f;font-weight:normal;margin-left:0.5em;padding:4px 8px 4px;display:inline-block;text-decoration:none;cursor:pointer;}/*!sc*/
|
||
data-styled.g92[id="sc-crHHJw"]{content:"iGcmRf,"}/*!sc*/
|
||
.gxSVta{width:9ex;display:inline-block;height:13px;line-height:13px;background-color:#333;border-radius:3px;background-repeat:no-repeat;background-position:6px 4px;font-size:7px;font-family:Verdana,sans-serif;color:white;text-transform:uppercase;text-align:center;font-weight:bold;vertical-align:middle;margin-right:6px;margin-top:2px;}/*!sc*/
|
||
.gxSVta.get{background-color:#2F8132;}/*!sc*/
|
||
.gxSVta.post{background-color:#186FAF;}/*!sc*/
|
||
.gxSVta.put{background-color:#95507c;}/*!sc*/
|
||
.gxSVta.options{background-color:#947014;}/*!sc*/
|
||
.gxSVta.patch{background-color:#bf581d;}/*!sc*/
|
||
.gxSVta.delete{background-color:#cc3333;}/*!sc*/
|
||
.gxSVta.basic{background-color:#707070;}/*!sc*/
|
||
.gxSVta.link{background-color:#07818F;}/*!sc*/
|
||
.gxSVta.head{background-color:#A23DAD;}/*!sc*/
|
||
.gxSVta.hook{background-color:#32329f;}/*!sc*/
|
||
.gxSVta.schema{background-color:#707070;}/*!sc*/
|
||
data-styled.g99[id="sc-dmcoYd"]{content:"gxSVta,"}/*!sc*/
|
||
.fTlmpg{margin:0;padding:0;}/*!sc*/
|
||
.fTlmpg:first-child{padding-bottom:32px;}/*!sc*/
|
||
.sc-YltrM .sc-YltrM{font-size:0.929em;}/*!sc*/
|
||
.dOKzVh{margin:0;padding:0;display:none;}/*!sc*/
|
||
.dOKzVh:first-child{padding-bottom:32px;}/*!sc*/
|
||
.sc-YltrM .sc-YltrM{font-size:0.929em;}/*!sc*/
|
||
data-styled.g100[id="sc-YltrM"]{content:"fTlmpg,dOKzVh,"}/*!sc*/
|
||
.kIUuLW{list-style:none inside none;overflow:hidden;text-overflow:ellipsis;padding:0;}/*!sc*/
|
||
data-styled.g101[id="sc-imiRDh"]{content:"kIUuLW,"}/*!sc*/
|
||
.jtSMDN{cursor:pointer;color:#333333;margin:0;padding:12.5px 20px;display:flex;justify-content:space-between;font-family:Montserrat,sans-serif;font-size:0.929em;text-transform:none;background-color:#fafafa;}/*!sc*/
|
||
.jtSMDN:hover{color:#32329f;background-color:#e1e1e1;}/*!sc*/
|
||
.jtSMDN .sc-eTNRI{height:1.5em;width:1.5em;}/*!sc*/
|
||
.jtSMDN .sc-eTNRI polygon{fill:#333333;}/*!sc*/
|
||
.gvinAL{cursor:pointer;color:#333333;margin:0;padding:12.5px 20px;display:flex;justify-content:space-between;font-family:Montserrat,sans-serif;background-color:#fafafa;}/*!sc*/
|
||
.gvinAL:hover{color:#32329f;background-color:#ededed;}/*!sc*/
|
||
.gvinAL .sc-eTNRI{height:1.5em;width:1.5em;}/*!sc*/
|
||
.gvinAL .sc-eTNRI polygon{fill:#333333;}/*!sc*/
|
||
data-styled.g102[id="sc-vIyEI"]{content:"jtSMDN,gvinAL,"}/*!sc*/
|
||
.fXgHFV{display:inline-block;vertical-align:middle;width:calc(100% - 38px);overflow:hidden;text-overflow:ellipsis;}/*!sc*/
|
||
data-styled.g103[id="sc-bjUHJT"]{content:"fXgHFV,"}/*!sc*/
|
||
.dWVQcL{font-size:0.8em;margin-top:10px;text-align:center;position:fixed;width:260px;bottom:0;background:#fafafa;}/*!sc*/
|
||
.dWVQcL a,.dWVQcL a:visited,.dWVQcL a:hover{color:#333333!important;padding:5px 0;border-top:1px solid #e1e1e1;text-decoration:none;display:flex;align-items:center;justify-content:center;}/*!sc*/
|
||
.dWVQcL img{width:15px;margin-right:5px;}/*!sc*/
|
||
@media screen and (max-width: 50rem){.dWVQcL{width:100%;}}/*!sc*/
|
||
data-styled.g104[id="sc-eIPYkq"]{content:"dWVQcL,"}/*!sc*/
|
||
.cIsduN{cursor:pointer;position:relative;margin-bottom:5px;}/*!sc*/
|
||
data-styled.g110[id="sc-bPrlCs"]{content:"cIsduN,"}/*!sc*/
|
||
.gllLir{font-family:Courier,monospace;margin-left:10px;flex:1;overflow-x:hidden;text-overflow:ellipsis;}/*!sc*/
|
||
data-styled.g111[id="sc-fYrVWQ"]{content:"gllLir,"}/*!sc*/
|
||
.bclCVA{outline:0;color:inherit;width:100%;text-align:left;cursor:pointer;padding:10px 30px 10px 20px;border-radius:4px 4px 0 0;background-color:#11171a;display:flex;white-space:nowrap;align-items:center;border:1px solid transparent;border-bottom:0;transition:border-color 0.25s ease;}/*!sc*/
|
||
.bclCVA ..sc-fYrVWQ{color:#ffffff;}/*!sc*/
|
||
.bclCVA:focus{box-shadow:inset 0 2px 2px rgba(0, 0, 0, 0.45),0 2px 0 rgba(128, 128, 128, 0.25);}/*!sc*/
|
||
data-styled.g112[id="sc-GkLId"]{content:"bclCVA,"}/*!sc*/
|
||
.eIFDdZ{font-size:0.929em;line-height:20px;background-color:#2F8132;color:#ffffff;padding:3px 10px;text-transform:uppercase;font-family:Montserrat,sans-serif;margin:0;}/*!sc*/
|
||
.hyHSPQ{font-size:0.929em;line-height:20px;background-color:#95507c;color:#ffffff;padding:3px 10px;text-transform:uppercase;font-family:Montserrat,sans-serif;margin:0;}/*!sc*/
|
||
.jUYA-DF{font-size:0.929em;line-height:20px;background-color:#cc3333;color:#ffffff;padding:3px 10px;text-transform:uppercase;font-family:Montserrat,sans-serif;margin:0;}/*!sc*/
|
||
.jBKVIL{font-size:0.929em;line-height:20px;background-color:#186FAF;color:#ffffff;padding:3px 10px;text-transform:uppercase;font-family:Montserrat,sans-serif;margin:0;}/*!sc*/
|
||
data-styled.g113[id="sc-jYnQyy"]{content:"eIFDdZ,hyHSPQ,jUYA-DF,jBKVIL,"}/*!sc*/
|
||
.hsEiws{position:absolute;width:100%;z-index:100;background:#fafafa;color:#263238;box-sizing:border-box;box-shadow:0 0 6px rgba(0, 0, 0, 0.33);overflow:hidden;border-bottom-left-radius:4px;border-bottom-right-radius:4px;transition:all 0.25s ease;visibility:hidden;transform:translateY(-50%) scaleY(0);}/*!sc*/
|
||
data-styled.g114[id="sc-eGgGjL"]{content:"hsEiws,"}/*!sc*/
|
||
.jerStl{padding:10px;}/*!sc*/
|
||
data-styled.g115[id="sc-fnpiog"]{content:"jerStl,"}/*!sc*/
|
||
.etvaCd{padding:5px;border:1px solid #ccc;background:#fff;word-break:break-all;color:#32329f;}/*!sc*/
|
||
.etvaCd >span{color:#333333;}/*!sc*/
|
||
data-styled.g116[id="sc-lkDHyp"]{content:"etvaCd,"}/*!sc*/
|
||
.gcZOqF{text-transform:lowercase;margin-left:0;line-height:1.5em;}/*!sc*/
|
||
data-styled.g117[id="sc-jnlcPO"]{content:"gcZOqF,"}/*!sc*/
|
||
.fIqGlH{display:block;border:0;width:100%;text-align:left;padding:10px;border-radius:2px;margin-bottom:4px;line-height:1.5em;cursor:pointer;color:#1d8127;background-color:rgba(29,129,39,0.07);}/*!sc*/
|
||
.fIqGlH:focus{outline:auto #1d8127;}/*!sc*/
|
||
.ideQht{display:block;border:0;width:100%;text-align:left;padding:10px;border-radius:2px;margin-bottom:4px;line-height:1.5em;cursor:pointer;color:#d41f1c;background-color:rgba(212,31,28,0.07);}/*!sc*/
|
||
.ideQht:focus{outline:auto #d41f1c;}/*!sc*/
|
||
.ifZPCr{display:block;border:0;width:100%;text-align:left;padding:10px;border-radius:2px;margin-bottom:4px;line-height:1.5em;cursor:pointer;color:#d41f1c;background-color:rgba(212,31,28,0.07);cursor:default;}/*!sc*/
|
||
.ifZPCr:focus{outline:auto #d41f1c;}/*!sc*/
|
||
.ifZPCr::before{content:"—";font-weight:bold;width:1.5em;text-align:center;display:inline-block;vertical-align:top;}/*!sc*/
|
||
.ifZPCr:focus{outline:0;}/*!sc*/
|
||
.iSOCsR{display:block;border:0;width:100%;text-align:left;padding:10px;border-radius:2px;margin-bottom:4px;line-height:1.5em;cursor:pointer;color:#1d8127;background-color:rgba(29,129,39,0.07);cursor:default;}/*!sc*/
|
||
.iSOCsR:focus{outline:auto #1d8127;}/*!sc*/
|
||
.iSOCsR::before{content:"—";font-weight:bold;width:1.5em;text-align:center;display:inline-block;vertical-align:top;}/*!sc*/
|
||
.iSOCsR:focus{outline:0;}/*!sc*/
|
||
data-styled.g119[id="sc-hsaIUA"]{content:"fIqGlH,ideQht,ifZPCr,iSOCsR,"}/*!sc*/
|
||
.ePkkgX{vertical-align:top;}/*!sc*/
|
||
data-styled.g122[id="sc-gWQvRS"]{content:"ePkkgX,"}/*!sc*/
|
||
.duKVDl{font-size:1.3em;padding:0.2em 0;margin:3em 0 1.1em;color:#333333;font-weight:normal;}/*!sc*/
|
||
data-styled.g123[id="sc-fYitVF"]{content:"duKVDl,"}/*!sc*/
|
||
.dZbpPF{margin-bottom:30px;}/*!sc*/
|
||
data-styled.g128[id="sc-eYFTNc"]{content:"dZbpPF,"}/*!sc*/
|
||
.bUvUmx{user-select:none;width:20px;height:20px;align-self:center;display:flex;flex-direction:column;color:#32329f;}/*!sc*/
|
||
data-styled.g129[id="sc-iEYVpv"]{content:"bUvUmx,"}/*!sc*/
|
||
.hHYXMN{width:260px;background-color:#fafafa;overflow:hidden;display:flex;flex-direction:column;backface-visibility:hidden;height:100vh;position:sticky;position:-webkit-sticky;top:0;}/*!sc*/
|
||
@media screen and (max-width: 50rem){.hHYXMN{position:fixed;z-index:20;width:100%;background:#fafafa;display:none;}}/*!sc*/
|
||
@media print{.hHYXMN{display:none;}}/*!sc*/
|
||
data-styled.g130[id="sc-iqziPC"]{content:"hHYXMN,"}/*!sc*/
|
||
.kHszPm{outline:none;user-select:none;background-color:#f2f2f2;color:#32329f;display:none;cursor:pointer;position:fixed;right:20px;z-index:100;border-radius:50%;box-shadow:0 0 20px rgba(0, 0, 0, 0.3);bottom:44px;width:60px;height:60px;padding:0 20px;}/*!sc*/
|
||
@media screen and (max-width: 50rem){.kHszPm{display:flex;}}/*!sc*/
|
||
.kHszPm svg{color:#0065FB;}/*!sc*/
|
||
@media print{.kHszPm{display:none;}}/*!sc*/
|
||
data-styled.g131[id="sc-eXzmLu"]{content:"kHszPm,"}/*!sc*/
|
||
.cSYMrW{font-family:Roboto,sans-serif;font-size:14px;font-weight:400;line-height:1.5em;color:#333333;display:flex;position:relative;text-align:left;-webkit-font-smoothing:antialiased;font-smoothing:antialiased;text-rendering:optimizeSpeed!important;tap-highlight-color:rgba(0, 0, 0, 0);text-size-adjust:100%;}/*!sc*/
|
||
.cSYMrW *{box-sizing:border-box;-webkit-tap-highlight-color:rgba(255, 255, 255, 0);}/*!sc*/
|
||
data-styled.g132[id="sc-kUNLVD"]{content:"cSYMrW,"}/*!sc*/
|
||
.cOuMek{z-index:1;position:relative;overflow:hidden;width:calc(100% - 260px);contain:layout;}/*!sc*/
|
||
@media print,screen and (max-width: 50rem){.cOuMek{width:100%;}}/*!sc*/
|
||
data-styled.g133[id="sc-dxfTlo"]{content:"cOuMek,"}/*!sc*/
|
||
.bsunyy{background:#263238;position:absolute;top:0;bottom:0;right:0;width:calc((100% - 260px) * 0.4);}/*!sc*/
|
||
@media print,screen and (max-width: 75rem){.bsunyy{display:none;}}/*!sc*/
|
||
data-styled.g134[id="sc-juusvx"]{content:"bsunyy,"}/*!sc*/
|
||
.cUtpgV{padding:5px 0;}/*!sc*/
|
||
data-styled.g135[id="sc-emwzcK"]{content:"cUtpgV,"}/*!sc*/
|
||
.iiRHzu{width:calc(100% - 40px);box-sizing:border-box;margin:0 20px;padding:5px 10px 5px 20px;border:0;border-bottom:1px solid #e1e1e1;font-family:Roboto,sans-serif;font-weight:bold;font-size:13px;color:#333333;background-color:transparent;outline:none;}/*!sc*/
|
||
data-styled.g136[id="sc-kjKYmT"]{content:"iiRHzu,"}/*!sc*/
|
||
.dvQijr{position:absolute;left:20px;height:1.8em;width:0.9em;}/*!sc*/
|
||
.dvQijr path{fill:#333333;}/*!sc*/
|
||
data-styled.g137[id="sc-cMdfCE"]{content:"dvQijr,"}/*!sc*/
|
||
</style>
|
||
<link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet">
|
||
</head>
|
||
|
||
<body>
|
||
|
||
<div id="redoc"><div class="sc-kUNLVD cSYMrW redoc-wrap"><div class="sc-iqziPC hHYXMN menu-content" style="top:0px;height:calc(100vh - 0px)"><div role="search" class="sc-emwzcK cUtpgV"><svg class="sc-cMdfCE dvQijr search-icon" version="1.1" viewBox="0 0 1000 1000" x="0px" xmlns="http://www.w3.org/2000/svg" y="0px"><path d="M968.2,849.4L667.3,549c83.9-136.5,66.7-317.4-51.7-435.6C477.1-25,252.5-25,113.9,113.4c-138.5,138.3-138.5,362.6,0,501C219.2,730.1,413.2,743,547.6,666.5l301.9,301.4c43.6,43.6,76.9,14.9,104.2-12.4C981,928.3,1011.8,893,968.2,849.4z M524.5,522c-88.9,88.7-233,88.7-321.8,0c-88.9-88.7-88.9-232.6,0-321.3c88.9-88.7,233-88.7,321.8,0C613.4,289.4,613.4,433.3,524.5,522z"></path></svg><input placeholder="Search..." aria-label="Search" type="text" class="sc-kjKYmT iiRHzu search-input" value=""/></div><div class="sc-kMzELR kIqtpW scrollbar-container undefined"><ul role="menu" class="sc-YltrM fTlmpg"><li tabindex="0" depth="1" data-item-id="tag/Distribution-Sets" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI jtSMDN -depth1"><span width="calc(100% - 38px)" title="Distribution Sets" class="sc-bjUHJT fXgHFV">Distribution Sets</span><svg class="sc-eTNRI gEokXu" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-YltrM dOKzVh"><li tabindex="0" depth="2" data-item-id="tag/Distribution-Sets/operation/getDistributionSet" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return single Distribution Set</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Distribution-Sets/operation/updateDistributionSet" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="put" class="sc-dmcoYd gxSVta operation-type put">put</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Update Distribution Set</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Distribution-Sets/operation/deleteDistributionSet" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="delete" class="sc-dmcoYd gxSVta operation-type delete">del</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Delete Distribution Set by Id</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Distribution-Sets/operation/getMetadataValue_2" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return single meta data value for a specific key of a Distribution Set</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Distribution-Sets/operation/updateMetadata_2" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="put" class="sc-dmcoYd gxSVta operation-type put">put</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Update single meta data value of a distribution set</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Distribution-Sets/operation/deleteMetadata_2" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="delete" class="sc-dmcoYd gxSVta operation-type delete">del</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Delete a single meta data entry from the distribution set</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Distribution-Sets/operation/getDistributionSets" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return all Distribution Sets</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Distribution-Sets/operation/createDistributionSets" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="post" class="sc-dmcoYd gxSVta operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Creates new Distribution Sets</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Distribution-Sets/operation/getMetadata_2" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return meta data for Distribution Set</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Distribution-Sets/operation/createMetadata_2" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="post" class="sc-dmcoYd gxSVta operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Create a list of meta data for a specific distribution set</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Distribution-Sets/operation/invalidateDistributionSet" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="post" class="sc-dmcoYd gxSVta operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Invalidate a distribution set</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Distribution-Sets/operation/getAssignedTargets_1" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return assigned targets to a specific distribution set</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Distribution-Sets/operation/createAssignedTarget" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="post" class="sc-dmcoYd gxSVta operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Assigning multiple targets to a single distribution set</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Distribution-Sets/operation/getAssignedSoftwareModules" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return the assigned software modules of a specific distribution set</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Distribution-Sets/operation/assignSoftwareModules" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="post" class="sc-dmcoYd gxSVta operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Assign a list of software modules to a distribution set</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Distribution-Sets/operation/getStatisticsForDistributionSet" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return Rollouts, Actions and Auto Assignments counts by Status for Distribution Set</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Distribution-Sets/operation/getRolloutsCountByStatusForDistributionSet" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return Rollouts count by status for Distribution Set</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Distribution-Sets/operation/getAutoAssignmentsCountForDistributionSet" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return Auto Assignments count for Distribution Set</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Distribution-Sets/operation/getActionsCountByStatusForDistributionSet" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return Actions count by status for Distribution Set</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Distribution-Sets/operation/getInstalledTargets" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return installed targets to a specific distribution set</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Distribution-Sets/operation/getAutoAssignTargetFilterQueries" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return target filter queries that have the given distribution set as auto assign DS</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Distribution-Sets/operation/deleteAssignSoftwareModules" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="delete" class="sc-dmcoYd gxSVta operation-type delete">del</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Delete the assignment of the software module from the distribution set</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Targets" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI jtSMDN -depth1"><span width="calc(100% - 38px)" title="Targets" class="sc-bjUHJT fXgHFV">Targets</span><svg class="sc-eTNRI gEokXu" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-YltrM dOKzVh"><li tabindex="0" depth="2" data-item-id="tag/Targets/operation/getTarget" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return target by id</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Targets/operation/updateTarget" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="put" class="sc-dmcoYd gxSVta operation-type put">put</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Update target by id</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Targets/operation/deleteTarget" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="delete" class="sc-dmcoYd gxSVta operation-type delete">del</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Delete target by id</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Targets/operation/getMetadataValue" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return single metadata value for a specific key of a target</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Targets/operation/updateMetadata" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="put" class="sc-dmcoYd gxSVta operation-type put">put</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Updates a single metadata value of a target</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Targets/operation/deleteMetadata" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="delete" class="sc-dmcoYd gxSVta operation-type delete">del</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Deletes a single metadata entry from a target</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Targets/operation/getAction" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return action by id of a specific target</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Targets/operation/updateAction" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="put" class="sc-dmcoYd gxSVta operation-type put">put</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Switch an action from soft to forced</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Targets/operation/cancelAction" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="delete" class="sc-dmcoYd gxSVta operation-type delete">del</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Cancel action for a specific target</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Targets/operation/updateActionConfirmation" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="put" class="sc-dmcoYd gxSVta operation-type put">put</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Controls (confirm/deny) actions waiting for confirmation</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Targets/operation/getTargets" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return all targets</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Targets/operation/createTargets" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="post" class="sc-dmcoYd gxSVta operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Create target(s)</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Targets/operation/assignTargetType" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="post" class="sc-dmcoYd gxSVta operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Assign target type to a target</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Targets/operation/unassignTargetType" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="delete" class="sc-dmcoYd gxSVta operation-type delete">del</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Unassign target type from target.</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Targets/operation/getMetadata" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return metadata for specific target</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Targets/operation/createMetadata" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="post" class="sc-dmcoYd gxSVta operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Create a list of metadata for a specific target</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Targets/operation/deactivateAutoConfirm" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="post" class="sc-dmcoYd gxSVta operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Deactivate auto-confirm on a specific target</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Targets/operation/activateAutoConfirm" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="post" class="sc-dmcoYd gxSVta operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Activate auto-confirm on a specific target</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Targets/operation/getAssignedDistributionSet" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return the assigned distribution set of a specific target</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Targets/operation/postAssignedDistributionSet" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="post" class="sc-dmcoYd gxSVta operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Assigns a distribution set to a specific target</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Targets/operation/getTags" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return tags for specific target</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Targets/operation/getInstalledDistributionSet" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return installed distribution set of a specific target</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Targets/operation/getAutoConfirmStatus" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return the current auto-confitm state for a specific target</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Targets/operation/getAttributes" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return attributes of a specific target</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Targets/operation/getActionHistory" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return actions for a specific target</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Targets/operation/getActionStatusList" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return status of a specific action on a specific target</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Actions" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI jtSMDN -depth1"><span width="calc(100% - 38px)" title="Actions" class="sc-bjUHJT fXgHFV">Actions</span><svg class="sc-eTNRI gEokXu" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-YltrM dOKzVh"><li tabindex="0" depth="2" data-item-id="tag/Actions/operation/getActions" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return all actions</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Actions/operation/getAction_1" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return action by id</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Basic-Authentication" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI jtSMDN -depth1"><span width="calc(100% - 38px)" title="Basic Authentication" class="sc-bjUHJT fXgHFV">Basic Authentication</span><svg class="sc-eTNRI gEokXu" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-YltrM dOKzVh"><li tabindex="0" depth="2" data-item-id="tag/Basic-Authentication/operation/validateBasicAuth" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">validateBasicAuth</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Software-Module-Types" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI jtSMDN -depth1"><span width="calc(100% - 38px)" title="Software Module Types" class="sc-bjUHJT fXgHFV">Software Module Types</span><svg class="sc-eTNRI gEokXu" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-YltrM dOKzVh"><li tabindex="0" depth="2" data-item-id="tag/Software-Module-Types/operation/getSoftwareModuleType" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return single Software Module Type</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Software-Module-Types/operation/updateSoftwareModuleType" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="put" class="sc-dmcoYd gxSVta operation-type put">put</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Update Software Module Type</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Software-Module-Types/operation/deleteSoftwareModuleType" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="delete" class="sc-dmcoYd gxSVta operation-type delete">del</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Delete Software Module Type by Id</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Software-Module-Types/operation/getTypes" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return all Software Module Types</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Software-Module-Types/operation/createSoftwareModuleTypes" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="post" class="sc-dmcoYd gxSVta operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Creates new Software Module Types</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Rollouts" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI jtSMDN -depth1"><span width="calc(100% - 38px)" title="Rollouts" class="sc-bjUHJT fXgHFV">Rollouts</span><svg class="sc-eTNRI gEokXu" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-YltrM dOKzVh"><li tabindex="0" depth="2" data-item-id="tag/Rollouts/operation/getRollout" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return single Rollout</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Rollouts/operation/update" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="put" class="sc-dmcoYd gxSVta operation-type put">put</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Update Rollout</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Rollouts/operation/delete" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="delete" class="sc-dmcoYd gxSVta operation-type delete">del</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Delete a Rollout</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Rollouts/operation/getRollouts" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return all Rollouts</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Rollouts/operation/create" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="post" class="sc-dmcoYd gxSVta operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Create a new Rollout</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Rollouts/operation/triggerNextGroup" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="post" class="sc-dmcoYd gxSVta operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Force trigger processing next group of a Rollout</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Rollouts/operation/start" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="post" class="sc-dmcoYd gxSVta operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Start a Rollout</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Rollouts/operation/retryRollout" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="post" class="sc-dmcoYd gxSVta operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Retry a rollout</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Rollouts/operation/resume" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="post" class="sc-dmcoYd gxSVta operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Resume a Rollout</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Rollouts/operation/pause" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="post" class="sc-dmcoYd gxSVta operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Pause a Rollout</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Rollouts/operation/deny" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="post" class="sc-dmcoYd gxSVta operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Deny a Rollout</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Rollouts/operation/approve" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="post" class="sc-dmcoYd gxSVta operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Approve a Rollout</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Rollouts/operation/getRolloutGroups" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return all rollout groups referred to a Rollout</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Rollouts/operation/getRolloutGroup" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return single rollout group</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Rollouts/operation/getRolloutGroupTargets" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return all targets related to a specific rollout group</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Target-Types" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI jtSMDN -depth1"><span width="calc(100% - 38px)" title="Target Types" class="sc-bjUHJT fXgHFV">Target Types</span><svg class="sc-eTNRI gEokXu" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-YltrM dOKzVh"><li tabindex="0" depth="2" data-item-id="tag/Target-Types/operation/getTargetType" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return target type by id</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Target-Types/operation/updateTargetType" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="put" class="sc-dmcoYd gxSVta operation-type put">put</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Update target type by id</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Target-Types/operation/deleteTargetType" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="delete" class="sc-dmcoYd gxSVta operation-type delete">del</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Delete target type by id</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Target-Types/operation/getTargetTypes" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return all target types</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Target-Types/operation/createTargetTypes" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="post" class="sc-dmcoYd gxSVta operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Create target types</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Target-Types/operation/getCompatibleDistributionSets" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return list of compatible distribution set types</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Target-Types/operation/addCompatibleDistributionSets" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="post" class="sc-dmcoYd gxSVta operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Adding compatibility of a distribution set type to a target type</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Target-Types/operation/removeCompatibleDistributionSet" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="delete" class="sc-dmcoYd gxSVta operation-type delete">del</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Remove compatibility of distribution set type from the target type</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Software-Modules" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI jtSMDN -depth1"><span width="calc(100% - 38px)" title="Software Modules" class="sc-bjUHJT fXgHFV">Software Modules</span><svg class="sc-eTNRI gEokXu" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-YltrM dOKzVh"><li tabindex="0" depth="2" data-item-id="tag/Software-Modules/operation/getSoftwareModule" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return Software Module by id</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Software-Modules/operation/updateSoftwareModule" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="put" class="sc-dmcoYd gxSVta operation-type put">put</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Update Software Module</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Software-Modules/operation/deleteSoftwareModule" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="delete" class="sc-dmcoYd gxSVta operation-type delete">del</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Delete Software Module by Id</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Software-Modules/operation/getMetadataValue_1" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return single metadata value for a specific key of a Software Module</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Software-Modules/operation/updateMetadata_1" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="put" class="sc-dmcoYd gxSVta operation-type put">put</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Update a single metadata value of a Software Module</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Software-Modules/operation/deleteMetadata_1" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="delete" class="sc-dmcoYd gxSVta operation-type delete">del</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Delete single metadata entry from the software module</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Software-Modules/operation/getSoftwareModules" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return all Software modules</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Software-Modules/operation/createSoftwareModules" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="post" class="sc-dmcoYd gxSVta operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Create Software Module(s)</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Software-Modules/operation/getMetadata_1" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return metadata for a Software Module</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Software-Modules/operation/createMetadata_1" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="post" class="sc-dmcoYd gxSVta operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Creates a list of metadata for a specific Software Module</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Software-Modules/operation/getArtifacts" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return all metadata of artifacts assigned to a software module</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Software-Modules/operation/uploadArtifact" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="post" class="sc-dmcoYd gxSVta operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Upload artifact</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Software-Modules/operation/getArtifact" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return single Artifact metadata</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Software-Modules/operation/deleteArtifact" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="delete" class="sc-dmcoYd gxSVta operation-type delete">del</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Delete artifact by Id</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Target-Tags" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI jtSMDN -depth1"><span width="calc(100% - 38px)" title="Target Tags" class="sc-bjUHJT fXgHFV">Target Tags</span><svg class="sc-eTNRI gEokXu" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-YltrM dOKzVh"><li tabindex="0" depth="2" data-item-id="tag/Target-Tags/operation/getTargetTag" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return target tag by id</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Target-Tags/operation/updateTargetTag" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="put" class="sc-dmcoYd gxSVta operation-type put">put</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Update target tag by id</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Target-Tags/operation/deleteTargetTag" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="delete" class="sc-dmcoYd gxSVta operation-type delete">del</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Delete target tag by id</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Target-Tags/operation/getAssignedTargets" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return assigned targets for tag</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Target-Tags/operation/assignTargets" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="put" class="sc-dmcoYd gxSVta operation-type put">put</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Assign target(s) to given tagId</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Target-Tags/operation/unassignTargets" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="delete" class="sc-dmcoYd gxSVta operation-type delete">del</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Unassign targets from a given tagId</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Target-Tags/operation/getTargetTags" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return all target tags</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Target-Tags/operation/createTargetTags" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="post" class="sc-dmcoYd gxSVta operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Create target tag(s)</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Target-Tags/operation/assignTarget" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="post" class="sc-dmcoYd gxSVta operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Assign target(s) to given tagId</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Target-Tags/operation/unassignTarget" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="delete" class="sc-dmcoYd gxSVta operation-type delete">del</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Unassign target from a given tagId</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Target-Filter-Queries" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI jtSMDN -depth1"><span width="calc(100% - 38px)" title="Target Filter Queries" class="sc-bjUHJT fXgHFV">Target Filter Queries</span><svg class="sc-eTNRI gEokXu" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-YltrM dOKzVh"><li tabindex="0" depth="2" data-item-id="tag/Target-Filter-Queries/operation/getFilter" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return target filter query by id</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Target-Filter-Queries/operation/updateFilter" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="put" class="sc-dmcoYd gxSVta operation-type put">put</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Updates target filter query by id</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Target-Filter-Queries/operation/deleteFilter" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="delete" class="sc-dmcoYd gxSVta operation-type delete">del</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Delete target filter by id</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Target-Filter-Queries/operation/getFilters" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return all target filter queries</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Target-Filter-Queries/operation/createFilter" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="post" class="sc-dmcoYd gxSVta operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Create target filter</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Target-Filter-Queries/operation/getAssignedDistributionSet_1" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return distribution set for auto assignment of a specific target filter</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Target-Filter-Queries/operation/postAssignedDistributionSet_1" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="post" class="sc-dmcoYd gxSVta operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Set auto assignment of distribution set for a target filter query</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Target-Filter-Queries/operation/deleteAssignedDistributionSet" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="delete" class="sc-dmcoYd gxSVta operation-type delete">del</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Remove Distribution Set for auto assignment of a target filter</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Download-artifact" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI jtSMDN -depth1"><span width="calc(100% - 38px)" title="Download artifact" class="sc-bjUHJT fXgHFV">Download artifact</span><svg class="sc-eTNRI gEokXu" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-YltrM dOKzVh"><li tabindex="0" depth="2" data-item-id="tag/Download-artifact/operation/downloadArtifact_1" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">downloadArtifact_1</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Distribution-Set-Tags" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI jtSMDN -depth1"><span width="calc(100% - 38px)" title="Distribution Set Tags" class="sc-bjUHJT fXgHFV">Distribution Set Tags</span><svg class="sc-eTNRI gEokXu" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-YltrM dOKzVh"><li tabindex="0" depth="2" data-item-id="tag/Distribution-Set-Tags/operation/getDistributionSetTag" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return single Distribution Set Tag</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Distribution-Set-Tags/operation/updateDistributionSetTag" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="put" class="sc-dmcoYd gxSVta operation-type put">put</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Update Distribution Set Tag</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Distribution-Set-Tags/operation/deleteDistributionSetTag" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="delete" class="sc-dmcoYd gxSVta operation-type delete">del</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Delete a single distribution set tag</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Distribution-Set-Tags/operation/getAssignedDistributionSets" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return all assigned distribution sets by given tag Id</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Distribution-Set-Tags/operation/assignDistributionSetsPut" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="put" class="sc-dmcoYd gxSVta operation-type put">put</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">assignDistributionSetsPut</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Distribution-Set-Tags/operation/assignDistributionSets" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="post" class="sc-dmcoYd gxSVta operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Assign distribution sets to the given tag id</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Distribution-Set-Tags/operation/unassignDistributionSets" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="delete" class="sc-dmcoYd gxSVta operation-type delete">del</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Unassign multiple distribution sets from the given tag id</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Distribution-Set-Tags/operation/getDistributionSetTags" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return all Distribution Set Tags</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Distribution-Set-Tags/operation/createDistributionSetTags" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="post" class="sc-dmcoYd gxSVta operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Creates new Distribution Set Tags</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Distribution-Set-Tags/operation/assignDistributionSet" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="post" class="sc-dmcoYd gxSVta operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Assign distribution set to the given tag id</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Distribution-Set-Tags/operation/unassignDistributionSet" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="delete" class="sc-dmcoYd gxSVta operation-type delete">del</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Unassign one distribution set from the given tag id</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Distribution-Set-Types" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI jtSMDN -depth1"><span width="calc(100% - 38px)" title="Distribution Set Types" class="sc-bjUHJT fXgHFV">Distribution Set Types</span><svg class="sc-eTNRI gEokXu" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-YltrM dOKzVh"><li tabindex="0" depth="2" data-item-id="tag/Distribution-Set-Types/operation/getDistributionSetType" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return single Distribution Set Type</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Distribution-Set-Types/operation/updateDistributionSetType" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="put" class="sc-dmcoYd gxSVta operation-type put">put</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Update Distribution Set Type</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Distribution-Set-Types/operation/deleteDistributionSetType" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="delete" class="sc-dmcoYd gxSVta operation-type delete">del</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Delete Distribution Set Type by Id</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Distribution-Set-Types/operation/getDistributionSetTypes" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return all Distribution Set Types</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Distribution-Set-Types/operation/createDistributionSetTypes" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="post" class="sc-dmcoYd gxSVta operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Create new distribution set types</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Distribution-Set-Types/operation/getOptionalModules" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return optional Software Module Types in a Distribution Set Type</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Distribution-Set-Types/operation/addOptionalModule" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="post" class="sc-dmcoYd gxSVta operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Add optional Software Module Type to a Distribution Set Type</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Distribution-Set-Types/operation/getMandatoryModules" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return mandatory Software Module Types in a Distribution Set Type</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Distribution-Set-Types/operation/addMandatoryModule" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="post" class="sc-dmcoYd gxSVta operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Add mandatory Software Module Type to a Distribution Set Type</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Distribution-Set-Types/operation/getOptionalModule" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return single optional Software Module Type in a Distribution Set Type</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Distribution-Set-Types/operation/removeOptionalModule" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="delete" class="sc-dmcoYd gxSVta operation-type delete">del</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Delete an optional module from a Distribution Set Type</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Distribution-Set-Types/operation/getMandatoryModule" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return single mandatory Software Module Type in a Distribution Set Type</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Distribution-Set-Types/operation/removeMandatoryModule" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="delete" class="sc-dmcoYd gxSVta operation-type delete">del</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Delete a mandatory module from a Distribution Set Type</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/System-Configuration" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI jtSMDN -depth1"><span width="calc(100% - 38px)" title="System Configuration" class="sc-bjUHJT fXgHFV">System Configuration</span><svg class="sc-eTNRI gEokXu" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-YltrM dOKzVh"><li tabindex="0" depth="2" data-item-id="tag/System-Configuration/operation/getTenantConfiguration" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return all tenant specific configuration values</span></label></li><li tabindex="0" depth="2" data-item-id="tag/System-Configuration/operation/updateTenantConfiguration" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="put" class="sc-dmcoYd gxSVta operation-type put">put</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Batch update of tenant configuration.</span></label></li><li tabindex="0" depth="2" data-item-id="tag/System-Configuration/operation/getTenantConfigurationValue" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="get" class="sc-dmcoYd gxSVta operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Return a tenant specific configuration value</span></label></li><li tabindex="0" depth="2" data-item-id="tag/System-Configuration/operation/updateTenantConfigurationValue" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="put" class="sc-dmcoYd gxSVta operation-type put">put</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Update a tenant specific configuration value.</span></label></li><li tabindex="0" depth="2" data-item-id="tag/System-Configuration/operation/deleteTenantConfigurationValue" role="menuitem" class="sc-imiRDh kIUuLW"><label class="sc-vIyEI gvinAL -depth2"><span type="delete" class="sc-dmcoYd gxSVta operation-type delete">del</span><span tabindex="0" width="calc(100% - 38px)" class="sc-bjUHJT fXgHFV">Delete a tenant specific configuration value</span></label></li></ul></li></ul><div class="sc-eIPYkq dWVQcL"><a target="_blank" rel="noopener noreferrer" href="https://redocly.com/redoc/">API docs by Redocly</a></div></div></div><div class="sc-eXzmLu kHszPm"><div class="sc-iEYVpv bUvUmx"><svg class="" style="transform:translate(2px, -4px) rotate(180deg);transition:transform 0.2s ease" viewBox="0 0 926.23699 573.74994" version="1.1" x="0px" y="0px" width="15" height="15"><g transform="translate(904.92214,-879.1482)"><path d="
|
||
m -673.67664,1221.6502 -231.2455,-231.24803 55.6165,
|
||
-55.627 c 30.5891,-30.59485 56.1806,-55.627 56.8701,-55.627 0.6894,
|
||
0 79.8637,78.60862 175.9427,174.68583 l 174.6892,174.6858 174.6892,
|
||
-174.6858 c 96.079,-96.07721 175.253196,-174.68583 175.942696,
|
||
-174.68583 0.6895,0 26.281,25.03215 56.8701,
|
||
55.627 l 55.6165,55.627 -231.245496,231.24803 c -127.185,127.1864
|
||
-231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688,
|
||
-104.0616 -231.873,-231.248 z
|
||
" fill="currentColor"></path></g></svg><svg class="" style="transform:translate(2px, 4px);transition:transform 0.2s ease" viewBox="0 0 926.23699 573.74994" version="1.1" x="0px" y="0px" width="15" height="15"><g transform="translate(904.92214,-879.1482)"><path d="
|
||
m -673.67664,1221.6502 -231.2455,-231.24803 55.6165,
|
||
-55.627 c 30.5891,-30.59485 56.1806,-55.627 56.8701,-55.627 0.6894,
|
||
0 79.8637,78.60862 175.9427,174.68583 l 174.6892,174.6858 174.6892,
|
||
-174.6858 c 96.079,-96.07721 175.253196,-174.68583 175.942696,
|
||
-174.68583 0.6895,0 26.281,25.03215 56.8701,
|
||
55.627 l 55.6165,55.627 -231.245496,231.24803 c -127.185,127.1864
|
||
-231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688,
|
||
-104.0616 -231.873,-231.248 z
|
||
" fill="currentColor"></path></g></svg></div></div><div class="sc-dxfTlo cOuMek api-content"><div class="sc-eDLKkx hNzKJC"><div class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY api-info"><h1 class="sc-fsYfdN sc-eFyDpN gqLiaw ObWVe">hawkBit REST APIs<!-- --> <span>(<!-- -->v1<!-- -->)</span></h1><p>Download OpenAPI specification<!-- -->:<a download="openapi.json" target="_blank" class="sc-crHHJw iGcmRf">Download</a></p><div class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"></div><div data-role="redoc-summary" html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"></div><div data-role="redoc-description" html="<p>Eclipse hawkBit™ is a domain-independent back-end framework for rolling out software updates to constrained edge devices as well as more powerful controllers and gateways connected to IP based networking infrastructure.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Eclipse hawkBit™ is a domain-independent back-end framework for rolling out software updates to constrained edge devices as well as more powerful controllers and gateways connected to IP based networking infrastructure.</p>
|
||
</div></div></div></div><div id="tag/Distribution-Sets" data-section-id="tag/Distribution-Sets" class="sc-eDLKkx hNzKJC"><div class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h1 class="sc-fsYfdN gqLiaw"><a class="sc-csKJxZ fNhImz" href="#tag/Distribution-Sets" aria-label="tag/Distribution-Sets"></a>Distribution Sets</h1></div></div><div class="sc-hLQSwg jSgyLg"><div class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS redoc-markdown " html="<p>REST Resource handling for DistributionSet CRUD operations.</p>
|
||
"><p>REST Resource handling for DistributionSet CRUD operations.</p>
|
||
</div></div></div><div id="tag/Distribution-Sets/operation/getDistributionSet" data-section-id="tag/Distribution-Sets/operation/getDistributionSet" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getDistributionSet" id="operation/getDistributionSet" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Distribution-Sets/operation/getDistributionSet" aria-label="tag/Distribution-Sets/operation/getDistributionSet"></a>Return single Distribution Set<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the GET request of retrieving a single distribution set. Required permission: READ_REPOSITORY</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the GET request of retrieving a single distribution set. Required permission: READ_REPOSITORY</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="distributionSetId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">distributionSetId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Distribution Set not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Distribution Set not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/distributionsets/{distributionSetId}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/distributionsets/{distributionSetId}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-0" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-2" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-3" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1" aria-labelledby="react-tabs-0"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token number">1682408574924</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408574925</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"DS"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"version"</span>: <span class="token string">"1.0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modules"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token number">1682408574921</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408574926</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"Firmware"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"version"</span>: <span class="token string">"1.0.42"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"os"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"typeName"</span>: <span class="token string">"OS"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"vendor"</span>: <span class="token string">"vendor Limited Inc, California"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"locked"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deleted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"encrypted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremodules/18">https://management-api.host.com/rest/v1/softwaremodules/18</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">18</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token number">1682408574920</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408574925</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"app runtime"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"version"</span>: <span class="token string">"1.0.25"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"runtime"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"typeName"</span>: <span class="token string">"runtime"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"vendor"</span>: <span class="token string">"vendor GmbH, Stuttgart, Germany"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"locked"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deleted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"encrypted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremodules/17">https://management-api.host.com/rest/v1/softwaremodules/17</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">17</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token number">1682408574919</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408574926</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"application"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"version"</span>: <span class="token string">"1.0.67"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"application"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"typeName"</span>: <span class="token string">"Application"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"vendor"</span>: <span class="token string">"vendor Limited, California"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"locked"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deleted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"encrypted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremodules/16">https://management-api.host.com/rest/v1/softwaremodules/16</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">16</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"requiredMigrationStep"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"test_default_ds_type"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"typeName"</span>: <span class="token string">"OS (FW) mandatory, runtime (FW) and app (SW) optional"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"complete"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deleted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"valid"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsets/6">https://management-api.host.com/rest/v1/distributionsets/6</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"modules"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsets/6/assignedSM?offset=0&limit=50">https://management-api.host.com/rest/v1/distributionsets/6/assignedSM?offset=0&limit=50</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsettypes/24">https://management-api.host.com/rest/v1/distributionsettypes/24</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsets/6/metadata?offset=0&limit=50">https://management-api.host.com/rest/v1/distributionsets/6/metadata?offset=0&limit=50</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token number">6</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-3" aria-labelledby="react-tabs-2"></div></div></div></div></div></div><div id="tag/Distribution-Sets/operation/updateDistributionSet" data-section-id="tag/Distribution-Sets/operation/updateDistributionSet" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/updateDistributionSet" id="operation/updateDistributionSet" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Distribution-Sets/operation/updateDistributionSet" aria-label="tag/Distribution-Sets/operation/updateDistributionSet"></a>Update Distribution Set<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the UPDATE request for a single Distribution Set. Required permission: UPDATE_REPOSITORY</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the UPDATE request for a single Distribution Set. Required permission: UPDATE_REPOSITORY</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="distributionSetId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">distributionSetId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><h5 class="sc-irLvIq cnGhhy">Request Body schema: <div class="sc-jIBlqr sc-hhyKGa bjIddV lkwvLJ"><svg class="sc-ilxebA bCxWCn" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div><div class="sc-gUjWJS sc-eKzvBH sc-jnlcPO itHPsH ciWJhv gcZOqF">required</div></h5><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"></div><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="name" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">name</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The name of the entity</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The name of the entity</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="description" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">description</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The description of the entity</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The description of the entity</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="version" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">version</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>Package version</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Package version</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="locked" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">locked</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">boolean</span></div> <div><div html="<p>Should be set only if change of locked state is requested. If put, the distribution set locked flag will be
|
||
set to the requested. Note: unlock (i.e. set this property to false) with extreme care!
|
||
In general once distribution set is locked it shall not be unlocked. Note that it could have been assigned /
|
||
deployed to targets.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Should be set only if change of locked state is requested. If put, the distribution set locked flag will be
|
||
set to the requested. Note: unlock (i.e. set this property to false) with extreme care!
|
||
In general once distribution set is locked it shall not be unlocked. Note that it could have been assigned /
|
||
deployed to targets.</p>
|
||
</div></div></div></td></tr><tr class="last "><td kind="field" title="requiredMigrationStep" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">requiredMigrationStep</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">boolean</span></div> <div><div html="<p>True if DS is a required migration step for another DS. As a result the DS’s assignment will not be cancelled
|
||
when another DS is assigned (note: updatable only if DS is not yet assigned to a target)</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>True if DS is a required migration step for another DS. As a result the DS’s assignment will not be cancelled
|
||
when another DS is assigned (note: updatable only if DS is not yet assigned to a target)</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Distribution Set not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Distribution Set not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">409<!-- --> </strong><div html="<p>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.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>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.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">415<!-- --> </strong><div html="<p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="put" class="sc-jYnQyy hyHSPQ http-verb put">put</span><span class="sc-fYrVWQ gllLir">/rest/v1/distributionsets/{distributionSetId}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/distributionsets/{distributionSetId}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Request samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-4" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-5" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-5" aria-labelledby="react-tabs-4"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"dsOne"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"Description of the distribution set."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"version"</span>: <span class="token string">"1.0.0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"locked"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"requiredMigrationStep"</span>: <span class="token boolean">false</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-6" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-7" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-8" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-9" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-7" aria-labelledby="react-tabs-6"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/json" selected="">application/json</option><option value="application/hal+json">application/hal+json</option></select><label>application/json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token number">1682408574924</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408574925</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"DS"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"version"</span>: <span class="token string">"1.0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modules"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token number">1682408574921</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408574926</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"Firmware"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"version"</span>: <span class="token string">"1.0.42"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"os"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"typeName"</span>: <span class="token string">"OS"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"vendor"</span>: <span class="token string">"vendor Limited Inc, California"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"locked"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deleted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"encrypted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremodules/18">https://management-api.host.com/rest/v1/softwaremodules/18</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">18</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token number">1682408574920</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408574925</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"app runtime"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"version"</span>: <span class="token string">"1.0.25"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"runtime"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"typeName"</span>: <span class="token string">"runtime"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"vendor"</span>: <span class="token string">"vendor GmbH, Stuttgart, Germany"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"locked"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deleted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"encrypted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremodules/17">https://management-api.host.com/rest/v1/softwaremodules/17</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">17</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token number">1682408574919</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408574926</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"application"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"version"</span>: <span class="token string">"1.0.67"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"application"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"typeName"</span>: <span class="token string">"Application"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"vendor"</span>: <span class="token string">"vendor Limited, California"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"locked"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deleted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"encrypted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremodules/16">https://management-api.host.com/rest/v1/softwaremodules/16</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">16</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"requiredMigrationStep"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"test_default_ds_type"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"typeName"</span>: <span class="token string">"OS (FW) mandatory, runtime (FW) and app (SW) optional"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"complete"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deleted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"valid"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsets/6">https://management-api.host.com/rest/v1/distributionsets/6</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"modules"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsets/6/assignedSM?offset=0&limit=50">https://management-api.host.com/rest/v1/distributionsets/6/assignedSM?offset=0&limit=50</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsettypes/24">https://management-api.host.com/rest/v1/distributionsettypes/24</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsets/6/metadata?offset=0&limit=50">https://management-api.host.com/rest/v1/distributionsets/6/metadata?offset=0&limit=50</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token number">6</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-9" aria-labelledby="react-tabs-8"></div></div></div></div></div></div><div id="tag/Distribution-Sets/operation/deleteDistributionSet" data-section-id="tag/Distribution-Sets/operation/deleteDistributionSet" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/deleteDistributionSet" id="operation/deleteDistributionSet" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Distribution-Sets/operation/deleteDistributionSet" aria-label="tag/Distribution-Sets/operation/deleteDistributionSet"></a>Delete Distribution Set by Id<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the DELETE request for a single Distribution Set. Required permission: DELETE_REPOSITORY</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the DELETE request for a single Distribution Set. Required permission: DELETE_REPOSITORY</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="distributionSetId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">distributionSetId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA iSOCsR" disabled=""><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Distribution Set not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Distribution Set not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="delete" class="sc-jYnQyy jUYA-DF http-verb delete">delete</span><span class="sc-fYrVWQ gllLir">/rest/v1/distributionsets/{distributionSetId}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/distributionsets/{distributionSetId}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-10" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-11" tabindex="0" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-11" aria-labelledby="react-tabs-10"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-dQmiwx jCmKdj">application/json</div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"exceptionClass"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errorCode"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"info"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Distribution-Sets/operation/getMetadataValue_2" data-section-id="tag/Distribution-Sets/operation/getMetadataValue_2" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getMetadataValue_2" id="operation/getMetadataValue_2" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Distribution-Sets/operation/getMetadataValue_2" aria-label="tag/Distribution-Sets/operation/getMetadataValue_2"></a>Return single meta data value for a specific key of a Distribution Set<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Get a single meta data value for a meta data key. Required permission: READ_REPOSITORY</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Get a single meta data value for a meta data key. Required permission: READ_REPOSITORY</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="distributionSetId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">distributionSetId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class="last "><td kind="field" title="metadataKey" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">metadataKey</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Distribution Set not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Distribution Set not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/distributionsets/{distributionSetId}/metadata/{metadataKey}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/distributionsets/{distributionSetId}/metadata/{metadataKey}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-12" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-13" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-14" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-15" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-13" aria-labelledby="react-tabs-12"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-dQmiwx jCmKdj">application/json</div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"key"</span>: <span class="token string">"someKnownKey"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">"someKnownKeyValue"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-15" aria-labelledby="react-tabs-14"></div></div></div></div></div></div><div id="tag/Distribution-Sets/operation/updateMetadata_2" data-section-id="tag/Distribution-Sets/operation/updateMetadata_2" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/updateMetadata_2" id="operation/updateMetadata_2" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Distribution-Sets/operation/updateMetadata_2" aria-label="tag/Distribution-Sets/operation/updateMetadata_2"></a>Update single meta data value of a distribution set<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Update a single meta data value for speficic key. Required permission: UPDATE_REPOSITORY</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Update a single meta data value for speficic key. Required permission: UPDATE_REPOSITORY</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="distributionSetId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">distributionSetId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class="last "><td kind="field" title="metadataKey" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">metadataKey</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><h5 class="sc-irLvIq cnGhhy">Request Body schema: <span class="sc-gYrqIg hJSqDi">application/json</span><div class="sc-gUjWJS sc-eKzvBH sc-jnlcPO itHPsH ciWJhv gcZOqF">required</div></h5><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"></div><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="value" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">value</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Distribution Set not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Distribution Set not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">409<!-- --> </strong><div html="<p>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.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>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.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">415<!-- --> </strong><div html="<p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="put" class="sc-jYnQyy hyHSPQ http-verb put">put</span><span class="sc-fYrVWQ gllLir">/rest/v1/distributionsets/{distributionSetId}/metadata/{metadataKey}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/distributionsets/{distributionSetId}/metadata/{metadataKey}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Request samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-16" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-17" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-17" aria-labelledby="react-tabs-16"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-dQmiwx jCmKdj">application/json</div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">"someValue"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-18" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-19" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-20" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-21" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-19" aria-labelledby="react-tabs-18"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"key"</span>: <span class="token string">"someKnownKey"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">"someKnownKeyValue"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-21" aria-labelledby="react-tabs-20"></div></div></div></div></div></div><div id="tag/Distribution-Sets/operation/deleteMetadata_2" data-section-id="tag/Distribution-Sets/operation/deleteMetadata_2" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/deleteMetadata_2" id="operation/deleteMetadata_2" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Distribution-Sets/operation/deleteMetadata_2" aria-label="tag/Distribution-Sets/operation/deleteMetadata_2"></a>Delete a single meta data entry from the distribution set<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Delete a single meta data. Required permission: UPDATE_REPOSITORY</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Delete a single meta data. Required permission: UPDATE_REPOSITORY</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="distributionSetId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">distributionSetId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class="last "><td kind="field" title="metadataKey" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">metadataKey</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA iSOCsR" disabled=""><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Distribution Set not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Distribution Set not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="delete" class="sc-jYnQyy jUYA-DF http-verb delete">delete</span><span class="sc-fYrVWQ gllLir">/rest/v1/distributionsets/{distributionSetId}/metadata/{metadataKey}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/distributionsets/{distributionSetId}/metadata/{metadataKey}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-22" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-23" tabindex="0" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-23" aria-labelledby="react-tabs-22"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-dQmiwx jCmKdj">application/json</div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"exceptionClass"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errorCode"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"info"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Distribution-Sets/operation/getDistributionSets" data-section-id="tag/Distribution-Sets/operation/getDistributionSets" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getDistributionSets" id="operation/getDistributionSets" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Distribution-Sets/operation/getDistributionSets" aria-label="tag/Distribution-Sets/operation/getDistributionSets"></a>Return all Distribution Sets<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the GET request of retrieving all distribution sets. Required permission: READ_REPOSITORY</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the GET request of retrieving all distribution sets. Required permission: READ_REPOSITORY</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">query<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="offset" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">offset</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Default:<!-- --> </span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">0</span></div> <div><div html="<p>The paging offset (default is 0)</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The paging offset (default is 0)</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="limit" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">limit</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Default:<!-- --> </span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">50</span></div> <div><div html="<p>The maximum number of entries in a page (default is 50)</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The maximum number of entries in a page (default is 50)</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="sort" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">sort</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The query parameter sort allows to define the sort order for the result of a query. A sort criteria
|
||
consists of the name of a field and the sort direction (ASC for ascending and DESC descending).
|
||
The sequence of the sort criteria (multiple can be used) defines the sort order of the entities
|
||
in the result.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The query parameter sort allows to define the sort order for the result of a query. A sort criteria
|
||
consists of the name of a field and the sort direction (ASC for ascending and DESC descending).
|
||
The sequence of the sort criteria (multiple can be used) defines the sort order of the entities
|
||
in the result.</p>
|
||
</div></div></div></td></tr><tr class="last "><td kind="field" title="q" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">q</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for
|
||
available fields.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for
|
||
available fields.</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/distributionsets</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/distributionsets</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-24" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-25" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-26" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-27" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-25" aria-labelledby="react-tabs-24"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"content"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token number">1682408574924</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408574925</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"DS"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"version"</span>: <span class="token string">"1.0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"modules"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token number">1682408574921</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408574926</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"Firmware"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"version"</span>: <span class="token string">"1.0.42"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"os"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"typeName"</span>: <span class="token string">"OS"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"vendor"</span>: <span class="token string">"vendor Limited Inc, California"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"locked"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deleted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"encrypted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremodules/18">https://management-api.host.com/rest/v1/softwaremodules/18</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">18</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token number">1682408574920</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408574925</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"app runtime"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"version"</span>: <span class="token string">"1.0.25"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"runtime"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"typeName"</span>: <span class="token string">"runtime"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"vendor"</span>: <span class="token string">"vendor GmbH, Stuttgart, Germany"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"locked"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deleted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"encrypted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremodules/17">https://management-api.host.com/rest/v1/softwaremodules/17</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">17</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token number">1682408574919</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408574926</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"application"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"version"</span>: <span class="token string">"1.0.67"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"application"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"typeName"</span>: <span class="token string">"Application"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"vendor"</span>: <span class="token string">"vendor Limited, California"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"locked"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deleted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"encrypted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremodules/16">https://management-api.host.com/rest/v1/softwaremodules/16</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">16</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"requiredMigrationStep"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"test_default_ds_type"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"typeName"</span>: <span class="token string">"OS (FW) mandatory, runtime (FW) and app (SW) optional"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"complete"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deleted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"valid"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsets/6">https://management-api.host.com/rest/v1/distributionsets/6</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"modules"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsets/6/assignedSM?offset=0&limit=50">https://management-api.host.com/rest/v1/distributionsets/6/assignedSM?offset=0&limit=50</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsettypes/24">https://management-api.host.com/rest/v1/distributionsettypes/24</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsets/6/metadata?offset=0&limit=50">https://management-api.host.com/rest/v1/distributionsets/6/metadata?offset=0&limit=50</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">6</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"total"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"size"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hreflang"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deprecation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"profile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"templated"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hreflang"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deprecation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"profile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"templated"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-27" aria-labelledby="react-tabs-26"></div></div></div></div></div></div><div id="tag/Distribution-Sets/operation/createDistributionSets" data-section-id="tag/Distribution-Sets/operation/createDistributionSets" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/createDistributionSets" id="operation/createDistributionSets" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Distribution-Sets/operation/createDistributionSets" aria-label="tag/Distribution-Sets/operation/createDistributionSets"></a>Creates new Distribution Sets<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the POST request of creating new distribution sets within Hawkbit. The request body must always be a list of sets. Required permission: CREATE_REPOSITORY</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the POST request of creating new distribution sets within Hawkbit. The request body must always be a list of sets. Required permission: CREATE_REPOSITORY</p>
|
||
</div></div><h5 class="sc-irLvIq cnGhhy">Request Body schema: <div class="sc-jIBlqr sc-hhyKGa bjIddV lkwvLJ"><svg class="sc-ilxebA bCxWCn" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div><div class="sc-gUjWJS sc-eKzvBH sc-jnlcPO itHPsH ciWJhv gcZOqF">required</div></h5><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"></div><div><div class="sc-bBkKde cplVKI"> Array </div><div class="sc-bbxCgr iZgtJR"><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="name" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">name</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The name of the entity</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The name of the entity</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="description" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">description</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The description of the entity</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The description of the entity</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="version" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">version</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>Package version</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Package version</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="locked" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">locked</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">boolean</span></div> <div><div html="<p>Should be set only if change of locked state is requested. If put, the distribution set locked flag will be
|
||
set to the requested. Note: unlock (i.e. set this property to false) with extreme care!
|
||
In general once distribution set is locked it shall not be unlocked. Note that it could have been assigned /
|
||
deployed to targets.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Should be set only if change of locked state is requested. If put, the distribution set locked flag will be
|
||
set to the requested. Note: unlock (i.e. set this property to false) with extreme care!
|
||
In general once distribution set is locked it shall not be unlocked. Note that it could have been assigned /
|
||
deployed to targets.</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="requiredMigrationStep" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">requiredMigrationStep</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">boolean</span></div> <div><div html="<p>True if DS is a required migration step for another DS. As a result the DS’s assignment will not be cancelled
|
||
when another DS is assigned (note: updatable only if DS is not yet assigned to a target)</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>True if DS is a required migration step for another DS. As a result the DS’s assignment will not be cancelled
|
||
when another DS is assigned (note: updatable only if DS is not yet assigned to a target)</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="modules" class="sc-hABBmJ sc-fHejqy sc-jiaSqj cqoAxn hfWKVF gIkRoy"><span class="sc-ifyrAs hIHfpT"></span><button aria-label="expand modules"><span class="property-name">modules</span><svg class="sc-eTNRI jIsRbK" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY">Array of </span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">objects</span><span class="sc-gUjWJS sc-jgraLO itHPsH iUxudT"> (<!-- -->MgmtSoftwareModuleAssignment<!-- -->) </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class="last "><td kind="field" title="type" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">type</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The type of the distribution set</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The type of the distribution set</p>
|
||
</div></div></div></td></tr></tbody></table></div><div class="sc-iuOOrT hPMvVd"></div></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">201<!-- --> </strong><div html="<p>Successfully created</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully created</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">409<!-- --> </strong><div html="<p>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.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>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.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">415<!-- --> </strong><div html="<p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="post" class="sc-jYnQyy jBKVIL http-verb post">post</span><span class="sc-fYrVWQ gllLir">/rest/v1/distributionsets</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/distributionsets</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Request samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-28" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-29" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-29" aria-labelledby="react-tabs-28"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"dsOne"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"Description of the distribution set."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"version"</span>: <span class="token string">"1.0.0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"locked"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"requiredMigrationStep"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"modules"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">108</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"test_default_ds_type"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-30" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-31" tabindex="0" data-rttab="true">201</li><li class="tab-error" role="tab" id="react-tabs-32" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-33" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-31" aria-labelledby="react-tabs-30"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token number">1682408574924</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408574925</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"DS"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"version"</span>: <span class="token string">"1.0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"modules"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token number">1682408574921</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408574926</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"Firmware"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"version"</span>: <span class="token string">"1.0.42"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"os"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"typeName"</span>: <span class="token string">"OS"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"vendor"</span>: <span class="token string">"vendor Limited Inc, California"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"locked"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deleted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"encrypted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremodules/18">https://management-api.host.com/rest/v1/softwaremodules/18</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">18</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token number">1682408574920</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408574925</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"app runtime"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"version"</span>: <span class="token string">"1.0.25"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"runtime"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"typeName"</span>: <span class="token string">"runtime"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"vendor"</span>: <span class="token string">"vendor GmbH, Stuttgart, Germany"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"locked"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deleted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"encrypted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremodules/17">https://management-api.host.com/rest/v1/softwaremodules/17</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">17</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token number">1682408574919</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408574926</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"application"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"version"</span>: <span class="token string">"1.0.67"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"application"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"typeName"</span>: <span class="token string">"Application"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"vendor"</span>: <span class="token string">"vendor Limited, California"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"locked"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deleted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"encrypted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremodules/16">https://management-api.host.com/rest/v1/softwaremodules/16</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">16</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"requiredMigrationStep"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"test_default_ds_type"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"typeName"</span>: <span class="token string">"OS (FW) mandatory, runtime (FW) and app (SW) optional"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"complete"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deleted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"valid"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsets/6">https://management-api.host.com/rest/v1/distributionsets/6</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"modules"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsets/6/assignedSM?offset=0&limit=50">https://management-api.host.com/rest/v1/distributionsets/6/assignedSM?offset=0&limit=50</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsettypes/24">https://management-api.host.com/rest/v1/distributionsettypes/24</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsets/6/metadata?offset=0&limit=50">https://management-api.host.com/rest/v1/distributionsets/6/metadata?offset=0&limit=50</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">6</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-33" aria-labelledby="react-tabs-32"></div></div></div></div></div></div><div id="tag/Distribution-Sets/operation/getMetadata_2" data-section-id="tag/Distribution-Sets/operation/getMetadata_2" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getMetadata_2" id="operation/getMetadata_2" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Distribution-Sets/operation/getMetadata_2" aria-label="tag/Distribution-Sets/operation/getMetadata_2"></a>Return meta data for Distribution Set<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Get a paged list of meta data for a distribution set. Required permission: READ_REPOSITORY</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Get a paged list of meta data for a distribution set. Required permission: READ_REPOSITORY</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="distributionSetId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">distributionSetId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h5 class="sc-irLvIq cnGhhy">query<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="offset" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">offset</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Default:<!-- --> </span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">0</span></div> <div><div html="<p>The paging offset (default is 0)</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The paging offset (default is 0)</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="limit" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">limit</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Default:<!-- --> </span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">50</span></div> <div><div html="<p>The maximum number of entries in a page (default is 50)</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The maximum number of entries in a page (default is 50)</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="sort" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">sort</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The query parameter sort allows to define the sort order for the result of a query. A sort criteria
|
||
consists of the name of a field and the sort direction (ASC for ascending and DESC descending).
|
||
The sequence of the sort criteria (multiple can be used) defines the sort order of the entities
|
||
in the result.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The query parameter sort allows to define the sort order for the result of a query. A sort criteria
|
||
consists of the name of a field and the sort direction (ASC for ascending and DESC descending).
|
||
The sequence of the sort criteria (multiple can be used) defines the sort order of the entities
|
||
in the result.</p>
|
||
</div></div></div></td></tr><tr class="last "><td kind="field" title="q" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">q</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for
|
||
available fields.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for
|
||
available fields.</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Distribution Set not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Distribution Set not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/distributionsets/{distributionSetId}/metadata</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/distributionsets/{distributionSetId}/metadata</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-34" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-35" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-36" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-37" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-35" aria-labelledby="react-tabs-34"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"content"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"key"</span>: <span class="token string">"someKnownKey"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"value"</span>: <span class="token string">"someKnownKeyValue"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"total"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"size"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hreflang"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deprecation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"profile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"templated"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hreflang"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deprecation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"profile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"templated"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-37" aria-labelledby="react-tabs-36"></div></div></div></div></div></div><div id="tag/Distribution-Sets/operation/createMetadata_2" data-section-id="tag/Distribution-Sets/operation/createMetadata_2" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/createMetadata_2" id="operation/createMetadata_2" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Distribution-Sets/operation/createMetadata_2" aria-label="tag/Distribution-Sets/operation/createMetadata_2"></a>Create a list of meta data for a specific distribution set<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Create a list of meta data entries Required permissions: READ_REPOSITORY and UPDATE_TARGET</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Create a list of meta data entries Required permissions: READ_REPOSITORY and UPDATE_TARGET</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="distributionSetId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">distributionSetId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><h5 class="sc-irLvIq cnGhhy">Request Body schema: <div class="sc-jIBlqr sc-hhyKGa bjIddV lkwvLJ"><svg class="sc-ilxebA bCxWCn" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/json" selected="">application/json</option><option value="application/hal+json">application/hal+json</option></select><label>application/json</label></div><div class="sc-gUjWJS sc-eKzvBH sc-jnlcPO itHPsH ciWJhv gcZOqF">required</div></h5><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"></div><div><div class="sc-bBkKde cplVKI"> Array </div><div class="sc-bbxCgr iZgtJR"><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="key" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">key</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>Metadata property key</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Metadata property key</p>
|
||
</div></div></div></td></tr><tr class="last "><td kind="field" title="value" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">value</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>Metadata property value</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Metadata property value</p>
|
||
</div></div></div></td></tr></tbody></table></div><div class="sc-iuOOrT hPMvVd"></div></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">201<!-- --> </strong><div html="<p>Successfully created</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully created</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Distribution Set not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Distribution Set not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">409<!-- --> </strong><div html="<p>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.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>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.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">415<!-- --> </strong><div html="<p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="post" class="sc-jYnQyy jBKVIL http-verb post">post</span><span class="sc-fYrVWQ gllLir">/rest/v1/distributionsets/{distributionSetId}/metadata</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/distributionsets/{distributionSetId}/metadata</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Request samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-38" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-39" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-39" aria-labelledby="react-tabs-38"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/json" selected="">application/json</option><option value="application/hal+json">application/hal+json</option></select><label>application/json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"key"</span>: <span class="token string">"someKnownKey"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"value"</span>: <span class="token string">"someKnownKeyValue"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-40" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-41" tabindex="0" data-rttab="true">201</li><li class="tab-error" role="tab" id="react-tabs-42" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-43" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-41" aria-labelledby="react-tabs-40"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"key"</span>: <span class="token string">"someKnownKey"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"value"</span>: <span class="token string">"someKnownKeyValue"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-43" aria-labelledby="react-tabs-42"></div></div></div></div></div></div><div id="tag/Distribution-Sets/operation/invalidateDistributionSet" data-section-id="tag/Distribution-Sets/operation/invalidateDistributionSet" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/invalidateDistributionSet" id="operation/invalidateDistributionSet" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Distribution-Sets/operation/invalidateDistributionSet" aria-label="tag/Distribution-Sets/operation/invalidateDistributionSet"></a>Invalidate a distribution set<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Invalidate a distribution set. Once a distribution set is invalidated, it can not be valid again. An invalidated
|
||
distribution set cannot be assigned to targets anymore. The distribution set that is going to be invalidated
|
||
will be removed from all auto assignments. Furthermore, the user can choose to cancel all rollouts and (force)
|
||
cancel all actions connected to this distribution set. Required permission: UPDATE_REPOSITORY, UPDATE_TARGET</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Invalidate a distribution set. Once a distribution set is invalidated, it can not be valid again. An invalidated
|
||
distribution set cannot be assigned to targets anymore. The distribution set that is going to be invalidated
|
||
will be removed from all auto assignments. Furthermore, the user can choose to cancel all rollouts and (force)
|
||
cancel all actions connected to this distribution set. Required permission: UPDATE_REPOSITORY, UPDATE_TARGET</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="distributionSetId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">distributionSetId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><h5 class="sc-irLvIq cnGhhy">Request Body schema: <div class="sc-jIBlqr sc-hhyKGa bjIddV lkwvLJ"><svg class="sc-ilxebA bCxWCn" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div><div class="sc-gUjWJS sc-eKzvBH sc-jnlcPO itHPsH ciWJhv gcZOqF">required</div></h5><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"></div><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="actionCancelationType" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">actionCancelationType</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Enum<!-- -->:</span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">"soft"</span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">"force"</span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">"none"</span> </div> <div><div html="<p>Type of cancelation for actions referring to the given distribution set</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Type of cancelation for actions referring to the given distribution set</p>
|
||
</div></div></div></td></tr><tr class="last "><td kind="field" title="cancelRollouts" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">cancelRollouts</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">boolean</span></div> <div><div html="<p>Defines if rollouts referring to this distribution set should be canceled</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Defines if rollouts referring to this distribution set should be canceled</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA iSOCsR" disabled=""><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Distribution Set not found</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Distribution Set not found</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">409<!-- --> </strong><div html="<p>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.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>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.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">415<!-- --> </strong><div html="<p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="post" class="sc-jYnQyy jBKVIL http-verb post">post</span><span class="sc-fYrVWQ gllLir">/rest/v1/distributionsets/{distributionSetId}/invalidate</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/distributionsets/{distributionSetId}/invalidate</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Request samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-44" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-45" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-45" aria-labelledby="react-tabs-44"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"actionCancelationType"</span>: <span class="token string">"soft"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"cancelRollouts"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-46" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-47" tabindex="0" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-47" aria-labelledby="react-tabs-46"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-dQmiwx jCmKdj">application/json</div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"exceptionClass"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errorCode"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"info"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Distribution-Sets/operation/getAssignedTargets_1" data-section-id="tag/Distribution-Sets/operation/getAssignedTargets_1" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getAssignedTargets_1" id="operation/getAssignedTargets_1" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Distribution-Sets/operation/getAssignedTargets_1" aria-label="tag/Distribution-Sets/operation/getAssignedTargets_1"></a>Return assigned targets to a specific distribution set<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the GET request for retrieving assigned targets of a single distribution set. Required permissions: READ_REPOSITORY and READ_TARGET</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the GET request for retrieving assigned targets of a single distribution set. Required permissions: READ_REPOSITORY and READ_TARGET</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="distributionSetId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">distributionSetId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h5 class="sc-irLvIq cnGhhy">query<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="offset" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">offset</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Default:<!-- --> </span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">0</span></div> <div><div html="<p>The paging offset (default is 0)</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The paging offset (default is 0)</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="limit" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">limit</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Default:<!-- --> </span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">50</span></div> <div><div html="<p>The maximum number of entries in a page (default is 50)</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The maximum number of entries in a page (default is 50)</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="sort" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">sort</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The query parameter sort allows to define the sort order for the result of a query. A sort criteria
|
||
consists of the name of a field and the sort direction (ASC for ascending and DESC descending).
|
||
The sequence of the sort criteria (multiple can be used) defines the sort order of the entities
|
||
in the result.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The query parameter sort allows to define the sort order for the result of a query. A sort criteria
|
||
consists of the name of a field and the sort direction (ASC for ascending and DESC descending).
|
||
The sequence of the sort criteria (multiple can be used) defines the sort order of the entities
|
||
in the result.</p>
|
||
</div></div></div></td></tr><tr class="last "><td kind="field" title="q" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">q</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for
|
||
available fields.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for
|
||
available fields.</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Distribution Set not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Distribution Set not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/distributionsets/{distributionSetId}/assignedTargets</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/distributionsets/{distributionSetId}/assignedTargets</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-48" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-49" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-50" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-51" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-49" aria-labelledby="react-tabs-48"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"content"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token number">1682408577979</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408577988</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"137"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"My name is 137"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"controllerId"</span>: <span class="token string">"137"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"updateStatus"</span>: <span class="token string">"in_sync"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastControllerRequestAt"</span>: <span class="token number">1682408577978</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"installedAt"</span>: <span class="token number">1682408577987</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ipAddress"</span>: <span class="token string">"192.168.0.1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"address"</span>: <span class="token string">"</span><a href="http://192.168.0.1">http://192.168.0.1</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"pollStatus"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"lastRequestAt"</span>: <span class="token number">1682408577978</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"nextExpectedRequestAt"</span>: <span class="token number">1682451777978</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"overdue"</span>: <span class="token boolean">false</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"securityToken"</span>: <span class="token string">"949f1c3487125467464a960d750373c1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"requestAttributes"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"targetType"</span>: <span class="token number">13</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"targetTypeName"</span>: <span class="token string">"defaultType"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"autoConfirmActive"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/137">https://management-api.host.com/rest/v1/targets/137</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"assignedDS"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/137/assignedDS">https://management-api.host.com/rest/v1/targets/137/assignedDS</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"installedDS"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/137/installedDS">https://management-api.host.com/rest/v1/targets/137/installedDS</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"attributes"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/137/attributes">https://management-api.host.com/rest/v1/targets/137/attributes</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"actions"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/137/actions?offset=0&limit=50&sort=id%253ADESC">https://management-api.host.com/rest/v1/targets/137/actions?offset=0&limit=50&sort=id%3ADESC</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/137/metadata?offset=0&limit=50">https://management-api.host.com/rest/v1/targets/137/metadata?offset=0&limit=50</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"targetType"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targettypes/13">https://management-api.host.com/rest/v1/targettypes/13</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"autoConfirm"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/137/autoConfirm">https://management-api.host.com/rest/v1/targets/137/autoConfirm</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"total"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"size"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hreflang"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deprecation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"profile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"templated"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hreflang"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deprecation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"profile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"templated"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-51" aria-labelledby="react-tabs-50"></div></div></div></div></div></div><div id="tag/Distribution-Sets/operation/createAssignedTarget" data-section-id="tag/Distribution-Sets/operation/createAssignedTarget" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/createAssignedTarget" id="operation/createAssignedTarget" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Distribution-Sets/operation/createAssignedTarget" aria-label="tag/Distribution-Sets/operation/createAssignedTarget"></a>Assigning multiple targets to a single distribution set<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the POST request for assigning multiple targets to a distribution set.The request body must always be a list of target IDs. Non-existing targets are silently ignored resulting in a valid response. Required permissions: READ_REPOSITORY and UPDATE_TARGET</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the POST request for assigning multiple targets to a distribution set.The request body must always be a list of target IDs. Non-existing targets are silently ignored resulting in a valid response. Required permissions: READ_REPOSITORY and UPDATE_TARGET</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="distributionSetId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">distributionSetId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h5 class="sc-irLvIq cnGhhy">query<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="offline" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">offline</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">boolean</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><h5 class="sc-irLvIq cnGhhy">Request Body schema: <div class="sc-jIBlqr sc-hhyKGa bjIddV lkwvLJ"><svg class="sc-ilxebA bCxWCn" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div><div class="sc-gUjWJS sc-eKzvBH sc-jnlcPO itHPsH ciWJhv gcZOqF">required</div></h5><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"></div><div><div class="sc-bBkKde cplVKI"> Array </div><div class="sc-bbxCgr iZgtJR"><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="id" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">id</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The technical identifier of the entity</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The technical identifier of the entity</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="forcetime" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">forcetime</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="<p>Forcetime in milliseconds</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Forcetime in milliseconds</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="type" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">type</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Enum<!-- -->:</span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">"soft"</span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">"forced"</span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">"timeforced"</span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">"downloadonly"</span> </div> <div><div html="<p>The type of the assignment</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The type of the assignment</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="maintenanceWindow" class="sc-hABBmJ sc-fHejqy sc-jiaSqj cqoAxn hfWKVF gIkRoy"><span class="sc-ifyrAs hIHfpT"></span><button aria-label="expand maintenanceWindow"><span class="property-name">maintenanceWindow</span><svg class="sc-eTNRI jIsRbK" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">object</span><span class="sc-gUjWJS sc-jgraLO itHPsH iUxudT"> (<!-- -->MgmtMaintenanceWindowRequestBody<!-- -->) </span></div> <div><div html="<p>Separation of download and install by defining a maintenance window for the installation</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Separation of download and install by defining a maintenance window for the installation</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="weight" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">weight</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div> <div><div html="<p>Importance of the assignment</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Importance of the assignment</p>
|
||
</div></div></div></td></tr><tr class="last "><td kind="field" title="confirmationRequired" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">confirmationRequired</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">boolean</span></div> <div><div html="<p>(Available with user consent flow active) Defines, if the confirmation is required for an action. Confirmation is required per default</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>(Available with user consent flow active) Defines, if the confirmation is required for an action. Confirmation is required per default</p>
|
||
</div></div></div></td></tr></tbody></table></div><div class="sc-iuOOrT hPMvVd"></div></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">409<!-- --> </strong><div html="<p>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.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>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.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">415<!-- --> </strong><div html="<p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="post" class="sc-jYnQyy jBKVIL http-verb post">post</span><span class="sc-fYrVWQ gllLir">/rest/v1/distributionsets/{distributionSetId}/assignedTargets</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/distributionsets/{distributionSetId}/assignedTargets</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Request samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-52" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-53" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-53" aria-labelledby="react-tabs-52"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"target4"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"forcetime"</span>: <span class="token number">1682408575278</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"soft"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"maintenanceWindow"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"schedule"</span>: <span class="token string">"10 12 14 3 8 ? 2023"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"duration"</span>: <span class="token string">"00:10:00"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"timezone"</span>: <span class="token string">"+00:00"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"weight"</span>: <span class="token number">100</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"confirmationRequired"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-54" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-55" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-56" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-57" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-55" aria-labelledby="react-tabs-54"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"alreadyAssigned"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"assignedActions"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hreflang"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deprecation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"profile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"templated"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hreflang"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deprecation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"profile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"templated"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hreflang"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deprecation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"profile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"templated"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hreflang"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deprecation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"profile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"templated"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"assigned"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"total"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-57" aria-labelledby="react-tabs-56"></div></div></div></div></div></div><div id="tag/Distribution-Sets/operation/getAssignedSoftwareModules" data-section-id="tag/Distribution-Sets/operation/getAssignedSoftwareModules" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getAssignedSoftwareModules" id="operation/getAssignedSoftwareModules" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Distribution-Sets/operation/getAssignedSoftwareModules" aria-label="tag/Distribution-Sets/operation/getAssignedSoftwareModules"></a>Return the assigned software modules of a specific distribution set<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the GET request of retrieving a single distribution set. Required permission: READ_REPOSITORY</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the GET request of retrieving a single distribution set. Required permission: READ_REPOSITORY</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="distributionSetId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">distributionSetId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h5 class="sc-irLvIq cnGhhy">query<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="offset" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">offset</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Default:<!-- --> </span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">0</span></div> <div><div html="<p>The paging offset (default is 0)</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The paging offset (default is 0)</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="limit" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">limit</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Default:<!-- --> </span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">50</span></div> <div><div html="<p>The maximum number of entries in a page (default is 50)</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The maximum number of entries in a page (default is 50)</p>
|
||
</div></div></div></td></tr><tr class="last "><td kind="field" title="sort" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">sort</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The query parameter sort allows to define the sort order for the result of a query. A sort criteria
|
||
consists of the name of a field and the sort direction (ASC for ascending and DESC descending).
|
||
The sequence of the sort criteria (multiple can be used) defines the sort order of the entities
|
||
in the result.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The query parameter sort allows to define the sort order for the result of a query. A sort criteria
|
||
consists of the name of a field and the sort direction (ASC for ascending and DESC descending).
|
||
The sequence of the sort criteria (multiple can be used) defines the sort order of the entities
|
||
in the result.</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Distribution Set not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Distribution Set not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/distributionsets/{distributionSetId}/assignedSM</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/distributionsets/{distributionSetId}/assignedSM</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-58" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-59" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-60" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-61" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-59" aria-labelledby="react-tabs-58"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"content"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token number">1682408572790</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408572791</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"os"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"a description"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"version"</span>: <span class="token string">"1.0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"os"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"typeName"</span>: <span class="token string">"OS"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"vendor"</span>: <span class="token string">"Vendor Limited, California"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"encrypted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"locked"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deleted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremodules/6">https://management-api.host.com/rest/v1/softwaremodules/6</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"artifacts"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremodules/6/artifacts">https://management-api.host.com/rest/v1/softwaremodules/6/artifacts</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremoduletypes/13">https://management-api.host.com/rest/v1/softwaremoduletypes/13</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremodules/6/metadata?offset=0&limit=50">https://management-api.host.com/rest/v1/softwaremodules/6/metadata?offset=0&limit=50</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">6</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"total"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"size"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hreflang"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deprecation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"profile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"templated"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hreflang"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deprecation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"profile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"templated"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-61" aria-labelledby="react-tabs-60"></div></div></div></div></div></div><div id="tag/Distribution-Sets/operation/assignSoftwareModules" data-section-id="tag/Distribution-Sets/operation/assignSoftwareModules" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/assignSoftwareModules" id="operation/assignSoftwareModules" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Distribution-Sets/operation/assignSoftwareModules" aria-label="tag/Distribution-Sets/operation/assignSoftwareModules"></a>Assign a list of software modules to a distribution set<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>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</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>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</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="distributionSetId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">distributionSetId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><h5 class="sc-irLvIq cnGhhy">Request Body schema: <div class="sc-jIBlqr sc-hhyKGa bjIddV lkwvLJ"><svg class="sc-ilxebA bCxWCn" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/json" selected="">application/json</option><option value="application/hal+json">application/hal+json</option></select><label>application/json</label></div><div class="sc-gUjWJS sc-eKzvBH sc-jnlcPO itHPsH ciWJhv gcZOqF">required</div></h5><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"></div><div><div class="sc-bBkKde cplVKI"> Array </div><div class="sc-bbxCgr iZgtJR"><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="id" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">id</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div class="sc-iuOOrT hPMvVd"></div></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA iSOCsR" disabled=""><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Distribution Set not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Distribution Set not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">409<!-- --> </strong><div html="<p>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.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>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.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">415<!-- --> </strong><div html="<p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="post" class="sc-jYnQyy jBKVIL http-verb post">post</span><span class="sc-fYrVWQ gllLir">/rest/v1/distributionsets/{distributionSetId}/assignedSM</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/distributionsets/{distributionSetId}/assignedSM</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Request samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-62" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-63" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-63" aria-labelledby="react-tabs-62"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/json" selected="">application/json</option><option value="application/hal+json">application/hal+json</option></select><label>application/json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">108</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-64" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-65" tabindex="0" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-65" aria-labelledby="react-tabs-64"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-dQmiwx jCmKdj">application/json</div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"exceptionClass"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errorCode"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"info"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Distribution-Sets/operation/getStatisticsForDistributionSet" data-section-id="tag/Distribution-Sets/operation/getStatisticsForDistributionSet" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getStatisticsForDistributionSet" id="operation/getStatisticsForDistributionSet" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Distribution-Sets/operation/getStatisticsForDistributionSet" aria-label="tag/Distribution-Sets/operation/getStatisticsForDistributionSet"></a>Return Rollouts, Actions and Auto Assignments counts by Status for Distribution Set<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the GET request of retrieving Rollouts, Actions and Auto Assignments counts by Status for Distribution Set</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the GET request of retrieving Rollouts, Actions and Auto Assignments counts by Status for Distribution Set</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="distributionSetId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">distributionSetId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Distribution Set not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Distribution Set not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/distributionsets/{distributionSetId}/statistics</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/distributionsets/{distributionSetId}/statistics</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-66" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-67" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-68" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-69" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-67" aria-labelledby="react-tabs-66"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"actions"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rollouts"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"totalAutoAssignments"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-69" aria-labelledby="react-tabs-68"></div></div></div></div></div></div><div id="tag/Distribution-Sets/operation/getRolloutsCountByStatusForDistributionSet" data-section-id="tag/Distribution-Sets/operation/getRolloutsCountByStatusForDistributionSet" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getRolloutsCountByStatusForDistributionSet" id="operation/getRolloutsCountByStatusForDistributionSet" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Distribution-Sets/operation/getRolloutsCountByStatusForDistributionSet" aria-label="tag/Distribution-Sets/operation/getRolloutsCountByStatusForDistributionSet"></a>Return Rollouts count by status for Distribution Set<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the GET request of retrieving Rollouts count by Status for Distribution Set</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the GET request of retrieving Rollouts count by Status for Distribution Set</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="distributionSetId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">distributionSetId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Distribution Set not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Distribution Set not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/distributionsets/{distributionSetId}/statistics/rollouts</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/distributionsets/{distributionSetId}/statistics/rollouts</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-70" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-71" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-72" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-73" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-71" aria-labelledby="react-tabs-70"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"actions"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rollouts"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"totalAutoAssignments"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-73" aria-labelledby="react-tabs-72"></div></div></div></div></div></div><div id="tag/Distribution-Sets/operation/getAutoAssignmentsCountForDistributionSet" data-section-id="tag/Distribution-Sets/operation/getAutoAssignmentsCountForDistributionSet" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getAutoAssignmentsCountForDistributionSet" id="operation/getAutoAssignmentsCountForDistributionSet" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Distribution-Sets/operation/getAutoAssignmentsCountForDistributionSet" aria-label="tag/Distribution-Sets/operation/getAutoAssignmentsCountForDistributionSet"></a>Return Auto Assignments count for Distribution Set<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the GET request of retrieving Auto Assignments count for Distribution Set</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the GET request of retrieving Auto Assignments count for Distribution Set</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="distributionSetId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">distributionSetId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Distribution Set not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Distribution Set not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/distributionsets/{distributionSetId}/statistics/autoassignments</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/distributionsets/{distributionSetId}/statistics/autoassignments</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-74" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-75" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-76" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-77" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-75" aria-labelledby="react-tabs-74"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"actions"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rollouts"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"totalAutoAssignments"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-77" aria-labelledby="react-tabs-76"></div></div></div></div></div></div><div id="tag/Distribution-Sets/operation/getActionsCountByStatusForDistributionSet" data-section-id="tag/Distribution-Sets/operation/getActionsCountByStatusForDistributionSet" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getActionsCountByStatusForDistributionSet" id="operation/getActionsCountByStatusForDistributionSet" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Distribution-Sets/operation/getActionsCountByStatusForDistributionSet" aria-label="tag/Distribution-Sets/operation/getActionsCountByStatusForDistributionSet"></a>Return Actions count by status for Distribution Set<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the GET request of retrieving Actions count by Status for Distribution Set</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the GET request of retrieving Actions count by Status for Distribution Set</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="distributionSetId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">distributionSetId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Distribution Set not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Distribution Set not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/distributionsets/{distributionSetId}/statistics/actions</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/distributionsets/{distributionSetId}/statistics/actions</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-78" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-79" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-80" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-81" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-79" aria-labelledby="react-tabs-78"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"actions"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rollouts"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"totalAutoAssignments"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-81" aria-labelledby="react-tabs-80"></div></div></div></div></div></div><div id="tag/Distribution-Sets/operation/getInstalledTargets" data-section-id="tag/Distribution-Sets/operation/getInstalledTargets" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getInstalledTargets" id="operation/getInstalledTargets" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Distribution-Sets/operation/getInstalledTargets" aria-label="tag/Distribution-Sets/operation/getInstalledTargets"></a>Return installed targets to a specific distribution set<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the GET request for retrieving installed targets of a single distribution set. Required permissions: READ_REPOSITORY and READ_TARGET</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the GET request for retrieving installed targets of a single distribution set. Required permissions: READ_REPOSITORY and READ_TARGET</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="distributionSetId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">distributionSetId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h5 class="sc-irLvIq cnGhhy">query<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="offset" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">offset</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Default:<!-- --> </span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">0</span></div> <div><div html="<p>The paging offset (default is 0)</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The paging offset (default is 0)</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="limit" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">limit</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Default:<!-- --> </span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">50</span></div> <div><div html="<p>The maximum number of entries in a page (default is 50)</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The maximum number of entries in a page (default is 50)</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="sort" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">sort</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The query parameter sort allows to define the sort order for the result of a query. A sort criteria
|
||
consists of the name of a field and the sort direction (ASC for ascending and DESC descending).
|
||
The sequence of the sort criteria (multiple can be used) defines the sort order of the entities
|
||
in the result.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The query parameter sort allows to define the sort order for the result of a query. A sort criteria
|
||
consists of the name of a field and the sort direction (ASC for ascending and DESC descending).
|
||
The sequence of the sort criteria (multiple can be used) defines the sort order of the entities
|
||
in the result.</p>
|
||
</div></div></div></td></tr><tr class="last "><td kind="field" title="q" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">q</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for
|
||
available fields.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for
|
||
available fields.</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Distribution Set not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Distribution Set not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/distributionsets/{distributionSetId}/installedTargets</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/distributionsets/{distributionSetId}/installedTargets</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-82" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-83" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-84" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-85" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-83" aria-labelledby="react-tabs-82"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"content"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token number">1682408577979</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408577988</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"137"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"My name is 137"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"controllerId"</span>: <span class="token string">"137"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"updateStatus"</span>: <span class="token string">"in_sync"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastControllerRequestAt"</span>: <span class="token number">1682408577978</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"installedAt"</span>: <span class="token number">1682408577987</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ipAddress"</span>: <span class="token string">"192.168.0.1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"address"</span>: <span class="token string">"</span><a href="http://192.168.0.1">http://192.168.0.1</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"pollStatus"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"lastRequestAt"</span>: <span class="token number">1682408577978</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"nextExpectedRequestAt"</span>: <span class="token number">1682451777978</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"overdue"</span>: <span class="token boolean">false</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"securityToken"</span>: <span class="token string">"949f1c3487125467464a960d750373c1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"requestAttributes"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"targetType"</span>: <span class="token number">13</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"targetTypeName"</span>: <span class="token string">"defaultType"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"autoConfirmActive"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/137">https://management-api.host.com/rest/v1/targets/137</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"assignedDS"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/137/assignedDS">https://management-api.host.com/rest/v1/targets/137/assignedDS</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"installedDS"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/137/installedDS">https://management-api.host.com/rest/v1/targets/137/installedDS</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"attributes"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/137/attributes">https://management-api.host.com/rest/v1/targets/137/attributes</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"actions"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/137/actions?offset=0&limit=50&sort=id%253ADESC">https://management-api.host.com/rest/v1/targets/137/actions?offset=0&limit=50&sort=id%3ADESC</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/137/metadata?offset=0&limit=50">https://management-api.host.com/rest/v1/targets/137/metadata?offset=0&limit=50</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"targetType"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targettypes/13">https://management-api.host.com/rest/v1/targettypes/13</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"autoConfirm"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/137/autoConfirm">https://management-api.host.com/rest/v1/targets/137/autoConfirm</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"total"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"size"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hreflang"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deprecation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"profile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"templated"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hreflang"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deprecation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"profile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"templated"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-85" aria-labelledby="react-tabs-84"></div></div></div></div></div></div><div id="tag/Distribution-Sets/operation/getAutoAssignTargetFilterQueries" data-section-id="tag/Distribution-Sets/operation/getAutoAssignTargetFilterQueries" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getAutoAssignTargetFilterQueries" id="operation/getAutoAssignTargetFilterQueries" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Distribution-Sets/operation/getAutoAssignTargetFilterQueries" aria-label="tag/Distribution-Sets/operation/getAutoAssignTargetFilterQueries"></a>Return target filter queries that have the given distribution set as auto assign DS<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the GET request for retrieving assigned target filter queries of a single distribution set. Required permissions: READ_REPOSITORY and READ_TARGET</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the GET request for retrieving assigned target filter queries of a single distribution set. Required permissions: READ_REPOSITORY and READ_TARGET</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="distributionSetId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">distributionSetId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h5 class="sc-irLvIq cnGhhy">query<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="offset" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">offset</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Default:<!-- --> </span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">0</span></div> <div><div html="<p>The paging offset (default is 0)</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The paging offset (default is 0)</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="limit" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">limit</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Default:<!-- --> </span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">50</span></div> <div><div html="<p>The maximum number of entries in a page (default is 50)</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The maximum number of entries in a page (default is 50)</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="sort" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">sort</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The query parameter sort allows to define the sort order for the result of a query. A sort criteria
|
||
consists of the name of a field and the sort direction (ASC for ascending and DESC descending).
|
||
The sequence of the sort criteria (multiple can be used) defines the sort order of the entities
|
||
in the result.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The query parameter sort allows to define the sort order for the result of a query. A sort criteria
|
||
consists of the name of a field and the sort direction (ASC for ascending and DESC descending).
|
||
The sequence of the sort criteria (multiple can be used) defines the sort order of the entities
|
||
in the result.</p>
|
||
</div></div></div></td></tr><tr class="last "><td kind="field" title="q" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">q</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for
|
||
available fields.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for
|
||
available fields.</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Distribution Set not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Distribution Set not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/distributionsets/{distributionSetId}/autoAssignTargetFilters</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/distributionsets/{distributionSetId}/autoAssignTargetFilters</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-86" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-87" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-88" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-89" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-87" aria-labelledby="react-tabs-86"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"content"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token number">1682408566380</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408566385</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"filter1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"query"</span>: <span class="token string">"name==*"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"autoAssignDistributionSet"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"autoAssignActionType"</span>: <span class="token string">"forced"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"autoAssignWeight"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"confirmationRequired"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targetfilters/5">https://management-api.host.com/rest/v1/targetfilters/5</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"autoAssignDS"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targetfilters/5/autoAssignDS">https://management-api.host.com/rest/v1/targetfilters/5/autoAssignDS</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">5</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"total"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"size"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hreflang"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deprecation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"profile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"templated"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hreflang"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deprecation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"profile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"templated"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-89" aria-labelledby="react-tabs-88"></div></div></div></div></div></div><div id="tag/Distribution-Sets/operation/deleteAssignSoftwareModules" data-section-id="tag/Distribution-Sets/operation/deleteAssignSoftwareModules" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/deleteAssignSoftwareModules" id="operation/deleteAssignSoftwareModules" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Distribution-Sets/operation/deleteAssignSoftwareModules" aria-label="tag/Distribution-Sets/operation/deleteAssignSoftwareModules"></a>Delete the assignment of the software module from the distribution set<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Delete an assignment. Required permission: UPDATE_REPOSITORY</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Delete an assignment. Required permission: UPDATE_REPOSITORY</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="distributionSetId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">distributionSetId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class="last "><td kind="field" title="softwareModuleId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">softwareModuleId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA iSOCsR" disabled=""><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Distribution Set not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Distribution Set not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="delete" class="sc-jYnQyy jUYA-DF http-verb delete">delete</span><span class="sc-fYrVWQ gllLir">/rest/v1/distributionsets/{distributionSetId}/assignedSM/{softwareModuleId}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/distributionsets/{distributionSetId}/assignedSM/{softwareModuleId}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-90" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-91" tabindex="0" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-91" aria-labelledby="react-tabs-90"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-dQmiwx jCmKdj">application/json</div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"exceptionClass"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errorCode"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"info"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Targets" data-section-id="tag/Targets" class="sc-eDLKkx hNzKJC"><div class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h1 class="sc-fsYfdN gqLiaw"><a class="sc-csKJxZ fNhImz" href="#tag/Targets" aria-label="tag/Targets"></a>Targets</h1></div></div><div class="sc-hLQSwg jSgyLg"><div class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS redoc-markdown " html="<p>REST API for Target CRUD operations.</p>
|
||
"><p>REST API for Target CRUD operations.</p>
|
||
</div></div></div><div id="tag/Targets/operation/getTarget" data-section-id="tag/Targets/operation/getTarget" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getTarget" id="operation/getTarget" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Targets/operation/getTarget" aria-label="tag/Targets/operation/getTarget"></a>Return target by id<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the GET request of retrieving a single target. Required Permission: READ_TARGET.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the GET request of retrieving a single target. Required Permission: READ_TARGET.</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="targetId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">targetId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Target not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Target not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/targets/{targetId}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/targets/{targetId}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-92" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-93" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-94" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-95" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-93" aria-labelledby="react-tabs-92"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token number">1682408577979</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408577988</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"137"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"My name is 137"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"controllerId"</span>: <span class="token string">"137"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"updateStatus"</span>: <span class="token string">"in_sync"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastControllerRequestAt"</span>: <span class="token number">1682408577978</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"installedAt"</span>: <span class="token number">1682408577987</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ipAddress"</span>: <span class="token string">"192.168.0.1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"address"</span>: <span class="token string">"</span><a href="http://192.168.0.1">http://192.168.0.1</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"pollStatus"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"lastRequestAt"</span>: <span class="token number">1682408577978</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"nextExpectedRequestAt"</span>: <span class="token number">1682451777978</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"overdue"</span>: <span class="token boolean">false</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"securityToken"</span>: <span class="token string">"949f1c3487125467464a960d750373c1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"requestAttributes"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"targetType"</span>: <span class="token number">13</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"targetTypeName"</span>: <span class="token string">"defaultType"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"autoConfirmActive"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/137">https://management-api.host.com/rest/v1/targets/137</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"assignedDS"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/137/assignedDS">https://management-api.host.com/rest/v1/targets/137/assignedDS</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"installedDS"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/137/installedDS">https://management-api.host.com/rest/v1/targets/137/installedDS</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"attributes"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/137/attributes">https://management-api.host.com/rest/v1/targets/137/attributes</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"actions"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/137/actions?offset=0&limit=50&sort=id%253ADESC">https://management-api.host.com/rest/v1/targets/137/actions?offset=0&limit=50&sort=id%3ADESC</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/137/metadata?offset=0&limit=50">https://management-api.host.com/rest/v1/targets/137/metadata?offset=0&limit=50</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"targetType"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targettypes/13">https://management-api.host.com/rest/v1/targettypes/13</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"autoConfirm"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/137/autoConfirm">https://management-api.host.com/rest/v1/targets/137/autoConfirm</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-95" aria-labelledby="react-tabs-94"></div></div></div></div></div></div><div id="tag/Targets/operation/updateTarget" data-section-id="tag/Targets/operation/updateTarget" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/updateTarget" id="operation/updateTarget" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Targets/operation/updateTarget" aria-label="tag/Targets/operation/updateTarget"></a>Update target by id<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the PUT request of updating a target. Required Permission: UPDATE_TARGET</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the PUT request of updating a target. Required Permission: UPDATE_TARGET</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="targetId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">targetId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><h5 class="sc-irLvIq cnGhhy">Request Body schema: <div class="sc-jIBlqr sc-hhyKGa bjIddV lkwvLJ"><svg class="sc-ilxebA bCxWCn" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div><div class="sc-gUjWJS sc-eKzvBH sc-jnlcPO itHPsH ciWJhv gcZOqF">required</div></h5><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"></div><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="name" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">name</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The name of the entity</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The name of the entity</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="description" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">description</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The description of the entity</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The description of the entity</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="controllerId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">controllerId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>Controller ID</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Controller ID</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="address" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">address</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The last known address URI of the target. Includes information of the target is connected either directly (DDI) through HTTP or indirectly (DMF) through amqp</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The last known address URI of the target. Includes information of the target is connected either directly (DDI) through HTTP or indirectly (DMF) through amqp</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="securityToken" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">securityToken</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>Pre-Shared key that allows targets to authenticate at Direct Device Integration API if enabled in the tenant settings</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Pre-Shared key that allows targets to authenticate at Direct Device Integration API if enabled in the tenant settings</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="requestAttributes" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">requestAttributes</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">boolean</span></div> <div><div html="<p>Request re-transmission of target attributes</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Request re-transmission of target attributes</p>
|
||
</div></div></div></td></tr><tr class="last "><td kind="field" title="targetType" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">targetType</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="<p>ID of the target type</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>ID of the target type</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Target not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Target not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">409<!-- --> </strong><div html="<p>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.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>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.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">415<!-- --> </strong><div html="<p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="put" class="sc-jYnQyy hyHSPQ http-verb put">put</span><span class="sc-fYrVWQ gllLir">/rest/v1/targets/{targetId}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/targets/{targetId}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Request samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-96" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-97" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-97" aria-labelledby="react-tabs-96"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"controllerName"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"Example description of a target"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"controllerId"</span>: <span class="token string">"123"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"address"</span>: <span class="token string">"</span><a href="https://192.168.0.1">https://192.168.0.1</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"securityToken"</span>: <span class="token string">"2345678DGGDGFTDzztgf"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"requestAttributes"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"targetType"</span>: <span class="token number">10</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-98" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-99" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-100" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-101" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-99" aria-labelledby="react-tabs-98"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token number">1682408577979</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408577988</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"137"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"My name is 137"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"controllerId"</span>: <span class="token string">"137"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"updateStatus"</span>: <span class="token string">"in_sync"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastControllerRequestAt"</span>: <span class="token number">1682408577978</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"installedAt"</span>: <span class="token number">1682408577987</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ipAddress"</span>: <span class="token string">"192.168.0.1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"address"</span>: <span class="token string">"</span><a href="http://192.168.0.1">http://192.168.0.1</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"pollStatus"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"lastRequestAt"</span>: <span class="token number">1682408577978</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"nextExpectedRequestAt"</span>: <span class="token number">1682451777978</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"overdue"</span>: <span class="token boolean">false</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"securityToken"</span>: <span class="token string">"949f1c3487125467464a960d750373c1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"requestAttributes"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"targetType"</span>: <span class="token number">13</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"targetTypeName"</span>: <span class="token string">"defaultType"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"autoConfirmActive"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/137">https://management-api.host.com/rest/v1/targets/137</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"assignedDS"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/137/assignedDS">https://management-api.host.com/rest/v1/targets/137/assignedDS</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"installedDS"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/137/installedDS">https://management-api.host.com/rest/v1/targets/137/installedDS</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"attributes"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/137/attributes">https://management-api.host.com/rest/v1/targets/137/attributes</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"actions"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/137/actions?offset=0&limit=50&sort=id%253ADESC">https://management-api.host.com/rest/v1/targets/137/actions?offset=0&limit=50&sort=id%3ADESC</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/137/metadata?offset=0&limit=50">https://management-api.host.com/rest/v1/targets/137/metadata?offset=0&limit=50</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"targetType"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targettypes/13">https://management-api.host.com/rest/v1/targettypes/13</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"autoConfirm"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/137/autoConfirm">https://management-api.host.com/rest/v1/targets/137/autoConfirm</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-101" aria-labelledby="react-tabs-100"></div></div></div></div></div></div><div id="tag/Targets/operation/deleteTarget" data-section-id="tag/Targets/operation/deleteTarget" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/deleteTarget" id="operation/deleteTarget" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Targets/operation/deleteTarget" aria-label="tag/Targets/operation/deleteTarget"></a>Delete target by id<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the DELETE request of deleting a single target. Required Permission: DELETE_TARGET</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the DELETE request of deleting a single target. Required Permission: DELETE_TARGET</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="targetId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">targetId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA iSOCsR" disabled=""><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Target not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Target not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="delete" class="sc-jYnQyy jUYA-DF http-verb delete">delete</span><span class="sc-fYrVWQ gllLir">/rest/v1/targets/{targetId}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/targets/{targetId}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-102" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-103" tabindex="0" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-103" aria-labelledby="react-tabs-102"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-dQmiwx jCmKdj">application/json</div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"exceptionClass"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errorCode"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"info"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Targets/operation/getMetadataValue" data-section-id="tag/Targets/operation/getMetadataValue" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getMetadataValue" id="operation/getMetadataValue" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Targets/operation/getMetadataValue" aria-label="tag/Targets/operation/getMetadataValue"></a>Return single metadata value for a specific key of a target<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Get a single metadata value for a metadata key. Required permission: READ_REPOSITORY</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Get a single metadata value for a metadata key. Required permission: READ_REPOSITORY</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="targetId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">targetId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class="last "><td kind="field" title="metadataKey" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">metadataKey</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Target not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Target not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/targets/{targetId}/metadata/{metadataKey}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/targets/{targetId}/metadata/{metadataKey}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-104" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-105" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-106" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-107" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-105" aria-labelledby="react-tabs-104"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-dQmiwx jCmKdj">application/json</div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"key"</span>: <span class="token string">"someKnownKey"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">"someKnownKeyValue"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-107" aria-labelledby="react-tabs-106"></div></div></div></div></div></div><div id="tag/Targets/operation/updateMetadata" data-section-id="tag/Targets/operation/updateMetadata" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/updateMetadata" id="operation/updateMetadata" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Targets/operation/updateMetadata" aria-label="tag/Targets/operation/updateMetadata"></a>Updates a single metadata value of a target<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Update a single metadata value for speficic key. Required permission: UPDATE_REPOSITORY</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Update a single metadata value for speficic key. Required permission: UPDATE_REPOSITORY</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="targetId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">targetId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class="last "><td kind="field" title="metadataKey" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">metadataKey</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><h5 class="sc-irLvIq cnGhhy">Request Body schema: <span class="sc-gYrqIg hJSqDi">application/json</span><div class="sc-gUjWJS sc-eKzvBH sc-jnlcPO itHPsH ciWJhv gcZOqF">required</div></h5><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"></div><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="value" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">value</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Target not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Target not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">409<!-- --> </strong><div html="<p>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.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>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.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">415<!-- --> </strong><div html="<p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="put" class="sc-jYnQyy hyHSPQ http-verb put">put</span><span class="sc-fYrVWQ gllLir">/rest/v1/targets/{targetId}/metadata/{metadataKey}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/targets/{targetId}/metadata/{metadataKey}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Request samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-108" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-109" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-109" aria-labelledby="react-tabs-108"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-dQmiwx jCmKdj">application/json</div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">"someValue"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-110" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-111" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-112" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-113" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-111" aria-labelledby="react-tabs-110"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"key"</span>: <span class="token string">"someKnownKey"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">"someKnownKeyValue"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-113" aria-labelledby="react-tabs-112"></div></div></div></div></div></div><div id="tag/Targets/operation/deleteMetadata" data-section-id="tag/Targets/operation/deleteMetadata" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/deleteMetadata" id="operation/deleteMetadata" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Targets/operation/deleteMetadata" aria-label="tag/Targets/operation/deleteMetadata"></a>Deletes a single metadata entry from a target<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Delete a single metadata. Required permission: UPDATE_REPOSITORY</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Delete a single metadata. Required permission: UPDATE_REPOSITORY</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="targetId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">targetId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class="last "><td kind="field" title="metadataKey" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">metadataKey</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA iSOCsR" disabled=""><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Target not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Target not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="delete" class="sc-jYnQyy jUYA-DF http-verb delete">delete</span><span class="sc-fYrVWQ gllLir">/rest/v1/targets/{targetId}/metadata/{metadataKey}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/targets/{targetId}/metadata/{metadataKey}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-114" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-115" tabindex="0" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-115" aria-labelledby="react-tabs-114"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-dQmiwx jCmKdj">application/json</div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"exceptionClass"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errorCode"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"info"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Targets/operation/getAction" data-section-id="tag/Targets/operation/getAction" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getAction" id="operation/getAction" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Targets/operation/getAction" aria-label="tag/Targets/operation/getAction"></a>Return action by id of a specific target<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the GET request of retrieving a specific action on a specific target. Required Permission: READ_TARGET</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the GET request of retrieving a specific action on a specific target. Required Permission: READ_TARGET</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="targetId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">targetId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class="last "><td kind="field" title="actionId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">actionId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Target not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Target not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/targets/{targetId}/actions/{actionId}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/targets/{targetId}/actions/{actionId}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-116" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-117" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-118" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-119" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-117" aria-labelledby="react-tabs-116"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token number">1682408571231</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408571265</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"update"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"finished"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"detailStatus"</span>: <span class="token string">"finished"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rollout"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rolloutName"</span>: <span class="token string">"rollout"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/target137/actions/1">https://management-api.host.com/rest/v1/targets/target137/actions/1</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"target"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/target137">https://management-api.host.com/rest/v1/targets/target137</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"target137"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"distributionset"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsets/1">https://management-api.host.com/rest/v1/distributionsets/1</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"DS:1.0"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"status"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/target137/actions/1/status?offset=0&limit=50&sort=id%253ADESC">https://management-api.host.com/rest/v1/targets/target137/actions/1/status?offset=0&limit=50&sort=id%3ADESC</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"rollout"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/rollouts/1">https://management-api.host.com/rest/v1/rollouts/1</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"rollout"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"forceType"</span>: <span class="token string">"forced"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-119" aria-labelledby="react-tabs-118"></div></div></div></div></div></div><div id="tag/Targets/operation/updateAction" data-section-id="tag/Targets/operation/updateAction" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/updateAction" id="operation/updateAction" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Targets/operation/updateAction" aria-label="tag/Targets/operation/updateAction"></a>Switch an action from soft to forced<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the PUT request to switch an action from soft to forced. Required Permission: UPDATE_TARGET.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the PUT request to switch an action from soft to forced. Required Permission: UPDATE_TARGET.</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="targetId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">targetId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class="last "><td kind="field" title="actionId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">actionId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><h5 class="sc-irLvIq cnGhhy">Request Body schema: <div class="sc-jIBlqr sc-hhyKGa bjIddV lkwvLJ"><svg class="sc-ilxebA bCxWCn" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div><div class="sc-gUjWJS sc-eKzvBH sc-jnlcPO itHPsH ciWJhv gcZOqF">required</div></h5><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"></div><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="forceType" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">forceType</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Enum<!-- -->:</span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">"soft"</span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">"forced"</span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">"timeforced"</span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">"downloadonly"</span> </div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Target not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Target not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">409<!-- --> </strong><div html="<p>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.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>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.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">415<!-- --> </strong><div html="<p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="put" class="sc-jYnQyy hyHSPQ http-verb put">put</span><span class="sc-fYrVWQ gllLir">/rest/v1/targets/{targetId}/actions/{actionId}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/targets/{targetId}/actions/{actionId}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Request samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-120" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-121" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-121" aria-labelledby="react-tabs-120"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"forceType"</span>: <span class="token string">"soft"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-122" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-123" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-124" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-125" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-123" aria-labelledby="react-tabs-122"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token number">1682408571231</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408571265</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"update"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"finished"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"detailStatus"</span>: <span class="token string">"finished"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rollout"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rolloutName"</span>: <span class="token string">"rollout"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/target137/actions/1">https://management-api.host.com/rest/v1/targets/target137/actions/1</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"target"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/target137">https://management-api.host.com/rest/v1/targets/target137</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"target137"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"distributionset"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsets/1">https://management-api.host.com/rest/v1/distributionsets/1</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"DS:1.0"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"status"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/target137/actions/1/status?offset=0&limit=50&sort=id%253ADESC">https://management-api.host.com/rest/v1/targets/target137/actions/1/status?offset=0&limit=50&sort=id%3ADESC</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"rollout"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/rollouts/1">https://management-api.host.com/rest/v1/rollouts/1</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"rollout"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"forceType"</span>: <span class="token string">"forced"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-125" aria-labelledby="react-tabs-124"></div></div></div></div></div></div><div id="tag/Targets/operation/cancelAction" data-section-id="tag/Targets/operation/cancelAction" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/cancelAction" id="operation/cancelAction" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Targets/operation/cancelAction" aria-label="tag/Targets/operation/cancelAction"></a>Cancel action for a specific target<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Cancels an active action, only active actions can be deleted. Required Permission: UPDATE_TARGET</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Cancels an active action, only active actions can be deleted. Required Permission: UPDATE_TARGET</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="targetId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">targetId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class="last "><td kind="field" title="actionId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">actionId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h5 class="sc-irLvIq cnGhhy">query<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="force" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">force</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">boolean</span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Default:<!-- --> </span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">false</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA iSOCsR" disabled=""><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Target not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Target not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="delete" class="sc-jYnQyy jUYA-DF http-verb delete">delete</span><span class="sc-fYrVWQ gllLir">/rest/v1/targets/{targetId}/actions/{actionId}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/targets/{targetId}/actions/{actionId}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-126" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-127" tabindex="0" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-127" aria-labelledby="react-tabs-126"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-dQmiwx jCmKdj">application/json</div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"exceptionClass"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errorCode"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"info"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Targets/operation/updateActionConfirmation" data-section-id="tag/Targets/operation/updateActionConfirmation" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/updateActionConfirmation" id="operation/updateActionConfirmation" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Targets/operation/updateActionConfirmation" aria-label="tag/Targets/operation/updateActionConfirmation"></a>Controls (confirm/deny) actions waiting for confirmation<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Either confirm or deny an action which is waiting for confirmation.
|
||
The action will be transferred into the RUNNING state in case confirming it.
|
||
The action will remain in WAITING_FOR_CONFIRMATION state in case denying it.
|
||
Required Permission: READ_REPOSITORY AND UPDATE_TARGET</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Either confirm or deny an action which is waiting for confirmation.
|
||
The action will be transferred into the RUNNING state in case confirming it.
|
||
The action will remain in WAITING_FOR_CONFIRMATION state in case denying it.
|
||
Required Permission: READ_REPOSITORY AND UPDATE_TARGET</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="targetId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">targetId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class="last "><td kind="field" title="actionId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">actionId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><h5 class="sc-irLvIq cnGhhy">Request Body schema: <div class="sc-jIBlqr sc-hhyKGa bjIddV lkwvLJ"><svg class="sc-ilxebA bCxWCn" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div><div class="sc-gUjWJS sc-eKzvBH sc-jnlcPO itHPsH ciWJhv gcZOqF">required</div></h5><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"></div><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="confirmation" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">confirmation</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Enum<!-- -->:</span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">"confirmed"</span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">"denied"</span> </div> <div><div html="<p>Action confirmation state</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Action confirmation state</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="code" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">code</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div> <div><div html="<p>(Optional) Individual status code</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>(Optional) Individual status code</p>
|
||
</div></div></div></td></tr><tr class="last "><td kind="field" title="details" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">details</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY">Array of </span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">strings</span></div> <div><div html="<p>List of detailed message information</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>List of detailed message information</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA iSOCsR" disabled=""><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully updated confirmation status of the action</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully updated confirmation status of the action</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Target or Action not found</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Target or Action not found</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">409<!-- --> </strong><div html="<p>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.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>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.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">410<!-- --> </strong><div html="<p>Action is not active anymore.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Action is not active anymore.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">415<!-- --> </strong><div html="<p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="put" class="sc-jYnQyy hyHSPQ http-verb put">put</span><span class="sc-fYrVWQ gllLir">/rest/v1/targets/{targetId}/actions/{actionId}/confirmation</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/targets/{targetId}/actions/{actionId}/confirmation</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Request samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-128" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-129" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-129" aria-labelledby="react-tabs-128"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"confirmation"</span>: <span class="token string">"confirmed"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"code"</span>: <span class="token number">200</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"details"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"Feedback message"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-130" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-131" tabindex="0" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-131" aria-labelledby="react-tabs-130"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-dQmiwx jCmKdj">application/json</div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"exceptionClass"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errorCode"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"info"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Targets/operation/getTargets" data-section-id="tag/Targets/operation/getTargets" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getTargets" id="operation/getTargets" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Targets/operation/getTargets" aria-label="tag/Targets/operation/getTargets"></a>Return all targets<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the GET request of retrieving all targets. Required permission: READ_TARGET</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the GET request of retrieving all targets. Required permission: READ_TARGET</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">query<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="offset" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">offset</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Default:<!-- --> </span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">0</span></div> <div><div html="<p>The paging offset (default is 0)</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The paging offset (default is 0)</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="limit" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">limit</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Default:<!-- --> </span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">50</span></div> <div><div html="<p>The maximum number of entries in a page (default is 50)</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The maximum number of entries in a page (default is 50)</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="sort" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">sort</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The query parameter sort allows to define the sort order for the result of a query. A sort criteria
|
||
consists of the name of a field and the sort direction (ASC for ascending and DESC descending).
|
||
The sequence of the sort criteria (multiple can be used) defines the sort order of the entities
|
||
in the result.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The query parameter sort allows to define the sort order for the result of a query. A sort criteria
|
||
consists of the name of a field and the sort direction (ASC for ascending and DESC descending).
|
||
The sequence of the sort criteria (multiple can be used) defines the sort order of the entities
|
||
in the result.</p>
|
||
</div></div></div></td></tr><tr class="last "><td kind="field" title="q" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">q</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for
|
||
available fields.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for
|
||
available fields.</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/targets</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/targets</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-132" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-133" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-134" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-135" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-133" aria-labelledby="react-tabs-132"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"content"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token number">1682408577979</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408577988</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"137"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"My name is 137"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"controllerId"</span>: <span class="token string">"137"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"updateStatus"</span>: <span class="token string">"in_sync"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastControllerRequestAt"</span>: <span class="token number">1682408577978</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"installedAt"</span>: <span class="token number">1682408577987</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ipAddress"</span>: <span class="token string">"192.168.0.1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"address"</span>: <span class="token string">"</span><a href="http://192.168.0.1">http://192.168.0.1</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"pollStatus"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"lastRequestAt"</span>: <span class="token number">1682408577978</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"nextExpectedRequestAt"</span>: <span class="token number">1682451777978</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"overdue"</span>: <span class="token boolean">false</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"securityToken"</span>: <span class="token string">"949f1c3487125467464a960d750373c1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"requestAttributes"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"targetType"</span>: <span class="token number">13</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"targetTypeName"</span>: <span class="token string">"defaultType"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"autoConfirmActive"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/137">https://management-api.host.com/rest/v1/targets/137</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"assignedDS"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/137/assignedDS">https://management-api.host.com/rest/v1/targets/137/assignedDS</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"installedDS"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/137/installedDS">https://management-api.host.com/rest/v1/targets/137/installedDS</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"attributes"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/137/attributes">https://management-api.host.com/rest/v1/targets/137/attributes</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"actions"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/137/actions?offset=0&limit=50&sort=id%253ADESC">https://management-api.host.com/rest/v1/targets/137/actions?offset=0&limit=50&sort=id%3ADESC</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/137/metadata?offset=0&limit=50">https://management-api.host.com/rest/v1/targets/137/metadata?offset=0&limit=50</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"targetType"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targettypes/13">https://management-api.host.com/rest/v1/targettypes/13</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"autoConfirm"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/137/autoConfirm">https://management-api.host.com/rest/v1/targets/137/autoConfirm</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"total"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"size"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hreflang"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deprecation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"profile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"templated"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hreflang"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deprecation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"profile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"templated"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-135" aria-labelledby="react-tabs-134"></div></div></div></div></div></div><div id="tag/Targets/operation/createTargets" data-section-id="tag/Targets/operation/createTargets" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/createTargets" id="operation/createTargets" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Targets/operation/createTargets" aria-label="tag/Targets/operation/createTargets"></a>Create target(s)<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the POST request of creating new targets. The request body must always be a list of targets. Required Permission: CREATE_TARGET</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the POST request of creating new targets. The request body must always be a list of targets. Required Permission: CREATE_TARGET</p>
|
||
</div></div><h5 class="sc-irLvIq cnGhhy">Request Body schema: <div class="sc-jIBlqr sc-hhyKGa bjIddV lkwvLJ"><svg class="sc-ilxebA bCxWCn" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div><div class="sc-gUjWJS sc-eKzvBH sc-jnlcPO itHPsH ciWJhv gcZOqF">required</div></h5><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"></div><div><div class="sc-bBkKde cplVKI"> Array </div><div class="sc-bbxCgr iZgtJR"><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="name" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">name</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The name of the entity</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The name of the entity</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="description" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">description</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The description of the entity</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The description of the entity</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="controllerId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">controllerId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>Controller ID</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Controller ID</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="address" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">address</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The last known address URI of the target. Includes information of the target is connected either directly (DDI) through HTTP or indirectly (DMF) through amqp</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The last known address URI of the target. Includes information of the target is connected either directly (DDI) through HTTP or indirectly (DMF) through amqp</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="securityToken" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">securityToken</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>Pre-Shared key that allows targets to authenticate at Direct Device Integration API if enabled in the tenant settings</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Pre-Shared key that allows targets to authenticate at Direct Device Integration API if enabled in the tenant settings</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="requestAttributes" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">requestAttributes</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">boolean</span></div> <div><div html="<p>Request re-transmission of target attributes</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Request re-transmission of target attributes</p>
|
||
</div></div></div></td></tr><tr class="last "><td kind="field" title="targetType" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">targetType</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="<p>ID of the target type</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>ID of the target type</p>
|
||
</div></div></div></td></tr></tbody></table></div><div class="sc-iuOOrT hPMvVd"></div></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">201<!-- --> </strong><div html="<p>Successfully created</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully created</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">409<!-- --> </strong><div html="<p>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.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>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.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">415<!-- --> </strong><div html="<p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="post" class="sc-jYnQyy jBKVIL http-verb post">post</span><span class="sc-fYrVWQ gllLir">/rest/v1/targets</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/targets</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Request samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-136" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-137" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-137" aria-labelledby="react-tabs-136"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"controllerName"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"Example description of a target"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"controllerId"</span>: <span class="token string">"123"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"address"</span>: <span class="token string">"</span><a href="https://192.168.0.1">https://192.168.0.1</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"securityToken"</span>: <span class="token string">"2345678DGGDGFTDzztgf"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"requestAttributes"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"targetType"</span>: <span class="token number">10</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-138" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-139" tabindex="0" data-rttab="true">201</li><li class="tab-error" role="tab" id="react-tabs-140" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-141" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-139" aria-labelledby="react-tabs-138"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token number">1682408577979</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408577988</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"137"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"My name is 137"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"controllerId"</span>: <span class="token string">"137"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"updateStatus"</span>: <span class="token string">"in_sync"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastControllerRequestAt"</span>: <span class="token number">1682408577978</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"installedAt"</span>: <span class="token number">1682408577987</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ipAddress"</span>: <span class="token string">"192.168.0.1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"address"</span>: <span class="token string">"</span><a href="http://192.168.0.1">http://192.168.0.1</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"pollStatus"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"lastRequestAt"</span>: <span class="token number">1682408577978</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"nextExpectedRequestAt"</span>: <span class="token number">1682451777978</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"overdue"</span>: <span class="token boolean">false</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"securityToken"</span>: <span class="token string">"949f1c3487125467464a960d750373c1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"requestAttributes"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"targetType"</span>: <span class="token number">13</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"targetTypeName"</span>: <span class="token string">"defaultType"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"autoConfirmActive"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/137">https://management-api.host.com/rest/v1/targets/137</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"assignedDS"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/137/assignedDS">https://management-api.host.com/rest/v1/targets/137/assignedDS</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"installedDS"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/137/installedDS">https://management-api.host.com/rest/v1/targets/137/installedDS</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"attributes"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/137/attributes">https://management-api.host.com/rest/v1/targets/137/attributes</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"actions"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/137/actions?offset=0&limit=50&sort=id%253ADESC">https://management-api.host.com/rest/v1/targets/137/actions?offset=0&limit=50&sort=id%3ADESC</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/137/metadata?offset=0&limit=50">https://management-api.host.com/rest/v1/targets/137/metadata?offset=0&limit=50</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"targetType"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targettypes/13">https://management-api.host.com/rest/v1/targettypes/13</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"autoConfirm"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/137/autoConfirm">https://management-api.host.com/rest/v1/targets/137/autoConfirm</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-141" aria-labelledby="react-tabs-140"></div></div></div></div></div></div><div id="tag/Targets/operation/assignTargetType" data-section-id="tag/Targets/operation/assignTargetType" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/assignTargetType" id="operation/assignTargetType" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Targets/operation/assignTargetType" aria-label="tag/Targets/operation/assignTargetType"></a>Assign target type to a target<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Assign or update the target type of a target. Required permission: UPDATE_TARGET</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Assign or update the target type of a target. Required permission: UPDATE_TARGET</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="targetId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">targetId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><h5 class="sc-irLvIq cnGhhy">Request Body schema: <div class="sc-jIBlqr sc-hhyKGa bjIddV lkwvLJ"><svg class="sc-ilxebA bCxWCn" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div><div class="sc-gUjWJS sc-eKzvBH sc-jnlcPO itHPsH ciWJhv gcZOqF">required</div></h5><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"></div><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="id" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">id</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA iSOCsR" disabled=""><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="post" class="sc-jYnQyy jBKVIL http-verb post">post</span><span class="sc-fYrVWQ gllLir">/rest/v1/targets/{targetId}/targettype</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/targets/{targetId}/targettype</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Request samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-142" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-143" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-143" aria-labelledby="react-tabs-142"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token number">108</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-144" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-145" tabindex="0" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-145" aria-labelledby="react-tabs-144"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-dQmiwx jCmKdj">application/json</div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"exceptionClass"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errorCode"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"info"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Targets/operation/unassignTargetType" data-section-id="tag/Targets/operation/unassignTargetType" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/unassignTargetType" id="operation/unassignTargetType" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Targets/operation/unassignTargetType" aria-label="tag/Targets/operation/unassignTargetType"></a>Unassign target type from target.<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Remove the target type from a target. The target type will be set to null. Required permission: UPDATE_TARGET</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Remove the target type from a target. The target type will be set to null. Required permission: UPDATE_TARGET</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="targetId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">targetId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA iSOCsR" disabled=""><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="delete" class="sc-jYnQyy jUYA-DF http-verb delete">delete</span><span class="sc-fYrVWQ gllLir">/rest/v1/targets/{targetId}/targettype</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/targets/{targetId}/targettype</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-146" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-147" tabindex="0" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-147" aria-labelledby="react-tabs-146"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-dQmiwx jCmKdj">application/json</div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"exceptionClass"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errorCode"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"info"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Targets/operation/getMetadata" data-section-id="tag/Targets/operation/getMetadata" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getMetadata" id="operation/getMetadata" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Targets/operation/getMetadata" aria-label="tag/Targets/operation/getMetadata"></a>Return metadata for specific target<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Get a paged list of metadata for a target. Required permission: READ_REPOSITORY</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Get a paged list of metadata for a target. Required permission: READ_REPOSITORY</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="targetId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">targetId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h5 class="sc-irLvIq cnGhhy">query<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="offset" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">offset</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Default:<!-- --> </span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">0</span></div> <div><div html="<p>The paging offset (default is 0)</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The paging offset (default is 0)</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="limit" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">limit</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Default:<!-- --> </span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">50</span></div> <div><div html="<p>The maximum number of entries in a page (default is 50)</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The maximum number of entries in a page (default is 50)</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="sort" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">sort</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The query parameter sort allows to define the sort order for the result of a query. A sort criteria
|
||
consists of the name of a field and the sort direction (ASC for ascending and DESC descending).
|
||
The sequence of the sort criteria (multiple can be used) defines the sort order of the entities
|
||
in the result.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The query parameter sort allows to define the sort order for the result of a query. A sort criteria
|
||
consists of the name of a field and the sort direction (ASC for ascending and DESC descending).
|
||
The sequence of the sort criteria (multiple can be used) defines the sort order of the entities
|
||
in the result.</p>
|
||
</div></div></div></td></tr><tr class="last "><td kind="field" title="q" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">q</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for
|
||
available fields.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for
|
||
available fields.</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Target not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Target not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/targets/{targetId}/metadata</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/targets/{targetId}/metadata</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-148" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-149" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-150" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-151" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-149" aria-labelledby="react-tabs-148"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"content"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"key"</span>: <span class="token string">"someKnownKey"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"value"</span>: <span class="token string">"someKnownKeyValue"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"total"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"size"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hreflang"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deprecation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"profile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"templated"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hreflang"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deprecation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"profile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"templated"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-151" aria-labelledby="react-tabs-150"></div></div></div></div></div></div><div id="tag/Targets/operation/createMetadata" data-section-id="tag/Targets/operation/createMetadata" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/createMetadata" id="operation/createMetadata" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Targets/operation/createMetadata" aria-label="tag/Targets/operation/createMetadata"></a>Create a list of metadata for a specific target<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Create a list of metadata entries Required permissions: READ_REPOSITORY and UPDATE_TARGET</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Create a list of metadata entries Required permissions: READ_REPOSITORY and UPDATE_TARGET</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="targetId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">targetId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><h5 class="sc-irLvIq cnGhhy">Request Body schema: <div class="sc-jIBlqr sc-hhyKGa bjIddV lkwvLJ"><svg class="sc-ilxebA bCxWCn" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/json" selected="">application/json</option><option value="application/hal+json">application/hal+json</option></select><label>application/json</label></div><div class="sc-gUjWJS sc-eKzvBH sc-jnlcPO itHPsH ciWJhv gcZOqF">required</div></h5><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"></div><div><div class="sc-bBkKde cplVKI"> Array </div><div class="sc-bbxCgr iZgtJR"><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="key" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">key</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>Metadata property key</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Metadata property key</p>
|
||
</div></div></div></td></tr><tr class="last "><td kind="field" title="value" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">value</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>Metadata property value</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Metadata property value</p>
|
||
</div></div></div></td></tr></tbody></table></div><div class="sc-iuOOrT hPMvVd"></div></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">201<!-- --> </strong><div html="<p>Successfully created</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully created</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Target not found</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Target not found</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">409<!-- --> </strong><div html="<p>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.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>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.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">415<!-- --> </strong><div html="<p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="post" class="sc-jYnQyy jBKVIL http-verb post">post</span><span class="sc-fYrVWQ gllLir">/rest/v1/targets/{targetId}/metadata</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/targets/{targetId}/metadata</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Request samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-152" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-153" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-153" aria-labelledby="react-tabs-152"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/json" selected="">application/json</option><option value="application/hal+json">application/hal+json</option></select><label>application/json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"key"</span>: <span class="token string">"someKnownKey"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"value"</span>: <span class="token string">"someKnownKeyValue"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-154" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-155" tabindex="0" data-rttab="true">201</li><li class="tab-error" role="tab" id="react-tabs-156" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-157" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-155" aria-labelledby="react-tabs-154"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"key"</span>: <span class="token string">"someKnownKey"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"value"</span>: <span class="token string">"someKnownKeyValue"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-157" aria-labelledby="react-tabs-156"></div></div></div></div></div></div><div id="tag/Targets/operation/deactivateAutoConfirm" data-section-id="tag/Targets/operation/deactivateAutoConfirm" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/deactivateAutoConfirm" id="operation/deactivateAutoConfirm" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Targets/operation/deactivateAutoConfirm" aria-label="tag/Targets/operation/deactivateAutoConfirm"></a>Deactivate auto-confirm on a specific target<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the POST request to deactivate auto-confirmation for a specific target. All active actions will remain unchanged while all future actions need to be confirmed, before processing with the deployment. Required Permission: UPDATE_TARGET</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the POST request to deactivate auto-confirmation for a specific target. All active actions will remain unchanged while all future actions need to be confirmed, before processing with the deployment. Required Permission: UPDATE_TARGET</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="targetId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">targetId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA iSOCsR" disabled=""><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Target not found</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Target not found</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">409<!-- --> </strong><div html="<p>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.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>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.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">415<!-- --> </strong><div html="<p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="post" class="sc-jYnQyy jBKVIL http-verb post">post</span><span class="sc-fYrVWQ gllLir">/rest/v1/targets/{targetId}/autoConfirm/deactivate</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/targets/{targetId}/autoConfirm/deactivate</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-158" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-159" tabindex="0" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-159" aria-labelledby="react-tabs-158"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-dQmiwx jCmKdj">application/json</div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"exceptionClass"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errorCode"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"info"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Targets/operation/activateAutoConfirm" data-section-id="tag/Targets/operation/activateAutoConfirm" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/activateAutoConfirm" id="operation/activateAutoConfirm" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Targets/operation/activateAutoConfirm" aria-label="tag/Targets/operation/activateAutoConfirm"></a>Activate auto-confirm on a specific target<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the POST request to activate auto-confirmation for a specific target. As a result all current active as well as future actions will automatically be confirmed by mentioning the initiator as triggered person. Actions will be automatically confirmed, as long as auto-confirmation is active. Required Permission: UPDATE_TARGET</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the POST request to activate auto-confirmation for a specific target. As a result all current active as well as future actions will automatically be confirmed by mentioning the initiator as triggered person. Actions will be automatically confirmed, as long as auto-confirmation is active. Required Permission: UPDATE_TARGET</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="targetId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">targetId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><h5 class="sc-irLvIq cnGhhy">Request Body schema: <span class="sc-gYrqIg hJSqDi">application/json</span></h5><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"></div><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="initiator" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">initiator</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>(Optional) Initiator set on activation</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>(Optional) Initiator set on activation</p>
|
||
</div></div></div></td></tr><tr class="last "><td kind="field" title="remark" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">remark</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>(Optional) Remark set on activation</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>(Optional) Remark set on activation</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA iSOCsR" disabled=""><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Target not found</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Target not found</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">409<!-- --> </strong><div html="<p>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.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>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.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">415<!-- --> </strong><div html="<p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="post" class="sc-jYnQyy jBKVIL http-verb post">post</span><span class="sc-fYrVWQ gllLir">/rest/v1/targets/{targetId}/autoConfirm/activate</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/targets/{targetId}/autoConfirm/activate</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Request samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-160" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-161" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-161" aria-labelledby="react-tabs-160"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-dQmiwx jCmKdj">application/json</div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"initiator"</span>: <span class="token string">"custom_initiator_value"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"remark"</span>: <span class="token string">"custom_remark"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-162" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-163" tabindex="0" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-163" aria-labelledby="react-tabs-162"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-dQmiwx jCmKdj">application/json</div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"exceptionClass"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errorCode"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"info"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Targets/operation/getAssignedDistributionSet" data-section-id="tag/Targets/operation/getAssignedDistributionSet" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getAssignedDistributionSet" id="operation/getAssignedDistributionSet" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Targets/operation/getAssignedDistributionSet" aria-label="tag/Targets/operation/getAssignedDistributionSet"></a>Return the assigned distribution set of a specific target<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the GET request of retrieving the assigned distribution set of an specific target. Required Permission: READ_TARGET</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the GET request of retrieving the assigned distribution set of an specific target. Required Permission: READ_TARGET</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="targetId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">targetId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Target not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Target not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/targets/{targetId}/assignedDS</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/targets/{targetId}/assignedDS</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-164" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-165" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-166" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-167" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-165" aria-labelledby="react-tabs-164"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token number">1682408574924</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408574925</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"DS"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"version"</span>: <span class="token string">"1.0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modules"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token number">1682408574921</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408574926</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"Firmware"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"version"</span>: <span class="token string">"1.0.42"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"os"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"typeName"</span>: <span class="token string">"OS"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"vendor"</span>: <span class="token string">"vendor Limited Inc, California"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"locked"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deleted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"encrypted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremodules/18">https://management-api.host.com/rest/v1/softwaremodules/18</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">18</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token number">1682408574920</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408574925</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"app runtime"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"version"</span>: <span class="token string">"1.0.25"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"runtime"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"typeName"</span>: <span class="token string">"runtime"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"vendor"</span>: <span class="token string">"vendor GmbH, Stuttgart, Germany"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"locked"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deleted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"encrypted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremodules/17">https://management-api.host.com/rest/v1/softwaremodules/17</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">17</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token number">1682408574919</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408574926</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"application"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"version"</span>: <span class="token string">"1.0.67"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"application"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"typeName"</span>: <span class="token string">"Application"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"vendor"</span>: <span class="token string">"vendor Limited, California"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"locked"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deleted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"encrypted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremodules/16">https://management-api.host.com/rest/v1/softwaremodules/16</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">16</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"requiredMigrationStep"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"test_default_ds_type"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"typeName"</span>: <span class="token string">"OS (FW) mandatory, runtime (FW) and app (SW) optional"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"complete"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deleted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"valid"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsets/6">https://management-api.host.com/rest/v1/distributionsets/6</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"modules"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsets/6/assignedSM?offset=0&limit=50">https://management-api.host.com/rest/v1/distributionsets/6/assignedSM?offset=0&limit=50</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsettypes/24">https://management-api.host.com/rest/v1/distributionsettypes/24</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsets/6/metadata?offset=0&limit=50">https://management-api.host.com/rest/v1/distributionsets/6/metadata?offset=0&limit=50</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token number">6</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-167" aria-labelledby="react-tabs-166"></div></div></div></div></div></div><div id="tag/Targets/operation/postAssignedDistributionSet" data-section-id="tag/Targets/operation/postAssignedDistributionSet" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/postAssignedDistributionSet" id="operation/postAssignedDistributionSet" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Targets/operation/postAssignedDistributionSet" aria-label="tag/Targets/operation/postAssignedDistributionSet"></a>Assigns a distribution set to a specific target<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the POST request for assigning a distribution set to a specific target. Required Permission: READ_REPOSITORY and UPDATE_TARGET</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the POST request for assigning a distribution set to a specific target. Required Permission: READ_REPOSITORY and UPDATE_TARGET</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="targetId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">targetId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h5 class="sc-irLvIq cnGhhy">query<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="offline" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">offline</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">boolean</span></div> <div><div html="<p>Offline update (set param to true) that is only reported but not managed by the service, e.g.
|
||
defaults set in factory, manual updates or migrations from other update systems. A completed action
|
||
is added to the history of the target(s). Target is set to IN_SYNC state as both assigned and
|
||
installed DS are set. Note: only executed if the target has currently no running update</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Offline update (set param to true) that is only reported but not managed by the service, e.g.
|
||
defaults set in factory, manual updates or migrations from other update systems. A completed action
|
||
is added to the history of the target(s). Target is set to IN_SYNC state as both assigned and
|
||
installed DS are set. Note: only executed if the target has currently no running update</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-irLvIq cnGhhy">Request Body schema: <div class="sc-jIBlqr sc-hhyKGa bjIddV lkwvLJ"><svg class="sc-ilxebA bCxWCn" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div><div class="sc-gUjWJS sc-eKzvBH sc-jnlcPO itHPsH ciWJhv gcZOqF">required</div></h5><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"></div><div><div class="sc-bBkKde cplVKI"> Array </div><div class="sc-bbxCgr iZgtJR"><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="id" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">id</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class=""><td kind="field" title="forcetime" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">forcetime</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="<p>Forcetime in milliseconds</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Forcetime in milliseconds</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="weight" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">weight</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div> <div><div html="<p>Importance of the assignment</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Importance of the assignment</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="confirmationRequired" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">confirmationRequired</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">boolean</span></div> <div><div html="<p>(Available with user consent flow active) Specifies if the confirmation by the device
|
||
is required for this action</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>(Available with user consent flow active) Specifies if the confirmation by the device
|
||
is required for this action</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="type" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">type</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Enum<!-- -->:</span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">"soft"</span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">"forced"</span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">"timeforced"</span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">"downloadonly"</span> </div> <div><div html="<p>The type of the assignment</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The type of the assignment</p>
|
||
</div></div></div></td></tr><tr class="last "><td kind="field" title="maintenanceWindow" class="sc-hABBmJ sc-fHejqy sc-jiaSqj cqoAxn hfWKVF gIkRoy"><span class="sc-ifyrAs hIHfpT"></span><button aria-label="expand maintenanceWindow"><span class="property-name">maintenanceWindow</span><svg class="sc-eTNRI jIsRbK" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">object</span><span class="sc-gUjWJS sc-jgraLO itHPsH iUxudT"> (<!-- -->MgmtMaintenanceWindowRequestBody<!-- -->) </span></div> <div><div html="<p>Separation of download and install by defining a maintenance window for the installation</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Separation of download and install by defining a maintenance window for the installation</p>
|
||
</div></div></div></td></tr></tbody></table></div><div class="sc-iuOOrT hPMvVd"></div></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Target not found</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Target not found</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">409<!-- --> </strong><div html="<p>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.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>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.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">415<!-- --> </strong><div html="<p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="post" class="sc-jYnQyy jBKVIL http-verb post">post</span><span class="sc-fYrVWQ gllLir">/rest/v1/targets/{targetId}/assignedDS</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/targets/{targetId}/assignedDS</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Request samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-168" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-169" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-169" aria-labelledby="react-tabs-168"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">108</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"forcetime"</span>: <span class="token number">1691065930359</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"weight"</span>: <span class="token number">23</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"confirmationRequired"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"soft"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"maintenanceWindow"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"schedule"</span>: <span class="token string">"10 12 14 3 8 ? 2023"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"duration"</span>: <span class="token string">"00:10:00"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"timezone"</span>: <span class="token string">"+00:00"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-170" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-171" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-172" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-173" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-171" aria-labelledby="react-tabs-170"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"alreadyAssigned"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"assignedActions"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hreflang"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deprecation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"profile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"templated"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hreflang"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deprecation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"profile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"templated"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hreflang"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deprecation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"profile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"templated"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hreflang"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deprecation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"profile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"templated"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"assigned"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"total"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-173" aria-labelledby="react-tabs-172"></div></div></div></div></div></div><div id="tag/Targets/operation/getTags" data-section-id="tag/Targets/operation/getTags" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getTags" id="operation/getTags" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Targets/operation/getTags" aria-label="tag/Targets/operation/getTags"></a>Return tags for specific target<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Get a paged list of tags for a target. Required permission: READ_REPOSITORY</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Get a paged list of tags for a target. Required permission: READ_REPOSITORY</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="targetId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">targetId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Target not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Target not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/targets/{targetId}/tags</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/targets/{targetId}/tags</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-174" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-175" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-175" aria-labelledby="react-tabs-174"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token number">1682408561990</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408561992</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"DsTag"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"My name is DsTag"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"colour"</span>: <span class="token string">"default"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsettags/6">https://management-api.host.com/rest/v1/distributionsettags/6</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"assignedDistributionSets"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsettags/6/assigned?offset=0&limit=50">https://management-api.host.com/rest/v1/distributionsettags/6/assigned?offset=0&limit=50</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">6</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Targets/operation/getInstalledDistributionSet" data-section-id="tag/Targets/operation/getInstalledDistributionSet" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getInstalledDistributionSet" id="operation/getInstalledDistributionSet" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Targets/operation/getInstalledDistributionSet" aria-label="tag/Targets/operation/getInstalledDistributionSet"></a>Return installed distribution set of a specific target<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the GET request of retrieving the installed distribution set of an specific target. Required Permission: READ_TARGET</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the GET request of retrieving the installed distribution set of an specific target. Required Permission: READ_TARGET</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="targetId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">targetId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Target not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Target not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/targets/{targetId}/installedDS</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/targets/{targetId}/installedDS</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-176" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-177" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-178" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-179" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-177" aria-labelledby="react-tabs-176"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token number">1682408574924</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408574925</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"DS"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"version"</span>: <span class="token string">"1.0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modules"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token number">1682408574921</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408574926</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"Firmware"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"version"</span>: <span class="token string">"1.0.42"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"os"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"typeName"</span>: <span class="token string">"OS"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"vendor"</span>: <span class="token string">"vendor Limited Inc, California"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"locked"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deleted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"encrypted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremodules/18">https://management-api.host.com/rest/v1/softwaremodules/18</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">18</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token number">1682408574920</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408574925</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"app runtime"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"version"</span>: <span class="token string">"1.0.25"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"runtime"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"typeName"</span>: <span class="token string">"runtime"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"vendor"</span>: <span class="token string">"vendor GmbH, Stuttgart, Germany"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"locked"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deleted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"encrypted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremodules/17">https://management-api.host.com/rest/v1/softwaremodules/17</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">17</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token number">1682408574919</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408574926</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"application"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"version"</span>: <span class="token string">"1.0.67"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"application"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"typeName"</span>: <span class="token string">"Application"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"vendor"</span>: <span class="token string">"vendor Limited, California"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"locked"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deleted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"encrypted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremodules/16">https://management-api.host.com/rest/v1/softwaremodules/16</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">16</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"requiredMigrationStep"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"test_default_ds_type"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"typeName"</span>: <span class="token string">"OS (FW) mandatory, runtime (FW) and app (SW) optional"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"complete"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deleted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"valid"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsets/6">https://management-api.host.com/rest/v1/distributionsets/6</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"modules"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsets/6/assignedSM?offset=0&limit=50">https://management-api.host.com/rest/v1/distributionsets/6/assignedSM?offset=0&limit=50</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsettypes/24">https://management-api.host.com/rest/v1/distributionsettypes/24</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsets/6/metadata?offset=0&limit=50">https://management-api.host.com/rest/v1/distributionsets/6/metadata?offset=0&limit=50</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token number">6</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-179" aria-labelledby="react-tabs-178"></div></div></div></div></div></div><div id="tag/Targets/operation/getAutoConfirmStatus" data-section-id="tag/Targets/operation/getAutoConfirmStatus" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getAutoConfirmStatus" id="operation/getAutoConfirmStatus" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Targets/operation/getAutoConfirmStatus" aria-label="tag/Targets/operation/getAutoConfirmStatus"></a>Return the current auto-confitm state for a specific target<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the GET request to check the current auto-confirmation state of a target. Required Permission: READ_TARGET</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the GET request to check the current auto-confirmation state of a target. Required Permission: READ_TARGET</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="targetId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">targetId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Target not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Target not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/targets/{targetId}/autoConfirm</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/targets/{targetId}/autoConfirm</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-180" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-181" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-182" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-183" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-181" aria-labelledby="react-tabs-180"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"active"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"initiator"</span>: <span class="token string">"custom_initiator_value"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"remark"</span>: <span class="token string">"custom_remark"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"activatedAt"</span>: <span class="token number">1682408577704</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"deactivate"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/137/autoConfirm/deactivate">https://management-api.host.com/rest/v1/targets/137/autoConfirm/deactivate</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-183" aria-labelledby="react-tabs-182"></div></div></div></div></div></div><div id="tag/Targets/operation/getAttributes" data-section-id="tag/Targets/operation/getAttributes" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getAttributes" id="operation/getAttributes" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Targets/operation/getAttributes" aria-label="tag/Targets/operation/getAttributes"></a>Return attributes of a specific target<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the GET request of retrieving the attributes of a specific target. Reponse is a key/value list. Required Permission: READ_TARGET</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the GET request of retrieving the attributes of a specific target. Reponse is a key/value list. Required Permission: READ_TARGET</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="targetId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">targetId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Target not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Target not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/targets/{targetId}/attributes</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/targets/{targetId}/attributes</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-184" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-185" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-186" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-187" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-185" aria-labelledby="react-tabs-184"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-187" aria-labelledby="react-tabs-186"></div></div></div></div></div></div><div id="tag/Targets/operation/getActionHistory" data-section-id="tag/Targets/operation/getActionHistory" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getActionHistory" id="operation/getActionHistory" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Targets/operation/getActionHistory" aria-label="tag/Targets/operation/getActionHistory"></a>Return actions for a specific target<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the GET request of retrieving the full action history of a specific target. Required Permission: READ_TARGET</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the GET request of retrieving the full action history of a specific target. Required Permission: READ_TARGET</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="targetId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">targetId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h5 class="sc-irLvIq cnGhhy">query<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="offset" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">offset</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Default:<!-- --> </span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">0</span></div> <div><div html="<p>The paging offset (default is 0)</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The paging offset (default is 0)</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="limit" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">limit</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Default:<!-- --> </span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">50</span></div> <div><div html="<p>The maximum number of entries in a page (default is 50)</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The maximum number of entries in a page (default is 50)</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="sort" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">sort</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The query parameter sort allows to define the sort order for the result of a query. A sort criteria
|
||
consists of the name of a field and the sort direction (ASC for ascending and DESC descending).
|
||
The sequence of the sort criteria (multiple can be used) defines the sort order of the entities
|
||
in the result.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The query parameter sort allows to define the sort order for the result of a query. A sort criteria
|
||
consists of the name of a field and the sort direction (ASC for ascending and DESC descending).
|
||
The sequence of the sort criteria (multiple can be used) defines the sort order of the entities
|
||
in the result.</p>
|
||
</div></div></div></td></tr><tr class="last "><td kind="field" title="q" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">q</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for
|
||
available fields.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for
|
||
available fields.</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Target not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Target not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/targets/{targetId}/actions</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/targets/{targetId}/actions</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-188" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-189" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-190" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-191" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-189" aria-labelledby="react-tabs-188"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"content"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token number">1682408571231</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408571265</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"update"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"status"</span>: <span class="token string">"finished"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"detailStatus"</span>: <span class="token string">"finished"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"rollout"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"rolloutName"</span>: <span class="token string">"rollout"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/target137/actions/1">https://management-api.host.com/rest/v1/targets/target137/actions/1</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"target"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/target137">https://management-api.host.com/rest/v1/targets/target137</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"target137"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"distributionset"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsets/1">https://management-api.host.com/rest/v1/distributionsets/1</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"DS:1.0"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"status"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/target137/actions/1/status?offset=0&limit=50&sort=id%253ADESC">https://management-api.host.com/rest/v1/targets/target137/actions/1/status?offset=0&limit=50&sort=id%3ADESC</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"rollout"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/rollouts/1">https://management-api.host.com/rest/v1/rollouts/1</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"rollout"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"forceType"</span>: <span class="token string">"forced"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"total"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"size"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hreflang"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deprecation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"profile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"templated"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hreflang"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deprecation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"profile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"templated"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-191" aria-labelledby="react-tabs-190"></div></div></div></div></div></div><div id="tag/Targets/operation/getActionStatusList" data-section-id="tag/Targets/operation/getActionStatusList" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getActionStatusList" id="operation/getActionStatusList" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Targets/operation/getActionStatusList" aria-label="tag/Targets/operation/getActionStatusList"></a>Return status of a specific action on a specific target<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the GET request of retrieving a specific action on a specific target. Required Permission: READ_TARGET</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the GET request of retrieving a specific action on a specific target. Required Permission: READ_TARGET</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="targetId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">targetId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class="last "><td kind="field" title="actionId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">actionId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h5 class="sc-irLvIq cnGhhy">query<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="offset" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">offset</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Default:<!-- --> </span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">0</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class=""><td kind="field" title="limit" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">limit</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Default:<!-- --> </span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">50</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class="last "><td kind="field" title="sort" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">sort</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Target not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Target not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/targets/{targetId}/actions/{actionId}/status</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/targets/{targetId}/actions/{actionId}/status</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-192" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-193" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-194" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-195" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-193" aria-labelledby="react-tabs-192"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"content"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">21</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"running"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"messages"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"reportedAt"</span>: <span class="token number">1691065929524</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"timestamp"</span>: <span class="token number">1691065929524</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"code"</span>: <span class="token number">200</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"total"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"size"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hreflang"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deprecation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"profile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"templated"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hreflang"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deprecation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"profile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"templated"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-195" aria-labelledby="react-tabs-194"></div></div></div></div></div></div><div id="tag/Actions" data-section-id="tag/Actions" class="sc-eDLKkx hNzKJC"><div class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h1 class="sc-fsYfdN gqLiaw"><a class="sc-csKJxZ fNhImz" href="#tag/Actions" aria-label="tag/Actions"></a>Actions</h1></div></div><div class="sc-hLQSwg jSgyLg"><div class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS redoc-markdown " html="<p>REST API providing (read-only) access to actions.</p>
|
||
"><p>REST API providing (read-only) access to actions.</p>
|
||
</div></div></div><div id="tag/Actions/operation/getActions" data-section-id="tag/Actions/operation/getActions" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getActions" id="operation/getActions" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Actions/operation/getActions" aria-label="tag/Actions/operation/getActions"></a>Return all actions<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the GET request of retrieving all actions.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the GET request of retrieving all actions.</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">query<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="offset" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">offset</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Default:<!-- --> </span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">0</span></div> <div><div html="<p>The paging offset (default is 0)</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The paging offset (default is 0)</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="limit" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">limit</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Default:<!-- --> </span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">50</span></div> <div><div html="<p>The maximum number of entries in a page (default is 50)</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The maximum number of entries in a page (default is 50)</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="sort" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">sort</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The query parameter sort allows to define the sort order for the result of a query. A sort criteria
|
||
consists of the name of a field and the sort direction (ASC for ascending and DESC descending).
|
||
The sequence of the sort criteria (multiple can be used) defines the sort order of the entities
|
||
in the result.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The query parameter sort allows to define the sort order for the result of a query. A sort criteria
|
||
consists of the name of a field and the sort direction (ASC for ascending and DESC descending).
|
||
The sequence of the sort criteria (multiple can be used) defines the sort order of the entities
|
||
in the result.</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="q" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">q</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for
|
||
available fields.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for
|
||
available fields.</p>
|
||
</div></div></div></td></tr><tr class="last "><td kind="field" title="representation" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">representation</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Default:<!-- --> </span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">"compact"</span></div> <div><div html="<p>The representation mode. Can be &quot;full&quot; or &quot;compact&quot;. Defaults to &quot;compact&quot;</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The representation mode. Can be "full" or "compact". Defaults to "compact"</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/actions</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/actions</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-196" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-197" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-198" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-199" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-197" aria-labelledby="react-tabs-196"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"content"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token number">1682408571231</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408571265</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"update"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"status"</span>: <span class="token string">"finished"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"detailStatus"</span>: <span class="token string">"finished"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"rollout"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"rolloutName"</span>: <span class="token string">"rollout"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/target137/actions/1">https://management-api.host.com/rest/v1/targets/target137/actions/1</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"target"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/target137">https://management-api.host.com/rest/v1/targets/target137</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"target137"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"distributionset"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsets/1">https://management-api.host.com/rest/v1/distributionsets/1</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"DS:1.0"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"status"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/target137/actions/1/status?offset=0&limit=50&sort=id%253ADESC">https://management-api.host.com/rest/v1/targets/target137/actions/1/status?offset=0&limit=50&sort=id%3ADESC</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"rollout"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/rollouts/1">https://management-api.host.com/rest/v1/rollouts/1</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"rollout"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"forceType"</span>: <span class="token string">"forced"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"total"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"size"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hreflang"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deprecation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"profile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"templated"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hreflang"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deprecation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"profile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"templated"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-199" aria-labelledby="react-tabs-198"></div></div></div></div></div></div><div id="tag/Actions/operation/getAction_1" data-section-id="tag/Actions/operation/getAction_1" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getAction_1" id="operation/getAction_1" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Actions/operation/getAction_1" aria-label="tag/Actions/operation/getAction_1"></a>Return action by id<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the GET request of retrieving a single action by actionId.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the GET request of retrieving a single action by actionId.</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="actionId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">actionId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Target not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Target not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/actions/{actionId}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/actions/{actionId}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-200" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-201" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-202" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-203" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-201" aria-labelledby="react-tabs-200"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token number">1682408571231</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408571265</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"update"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"finished"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"detailStatus"</span>: <span class="token string">"finished"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rollout"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rolloutName"</span>: <span class="token string">"rollout"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/target137/actions/1">https://management-api.host.com/rest/v1/targets/target137/actions/1</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"target"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/target137">https://management-api.host.com/rest/v1/targets/target137</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"target137"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"distributionset"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsets/1">https://management-api.host.com/rest/v1/distributionsets/1</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"DS:1.0"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"status"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/target137/actions/1/status?offset=0&limit=50&sort=id%253ADESC">https://management-api.host.com/rest/v1/targets/target137/actions/1/status?offset=0&limit=50&sort=id%3ADESC</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"rollout"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/rollouts/1">https://management-api.host.com/rest/v1/rollouts/1</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"rollout"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"forceType"</span>: <span class="token string">"forced"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-203" aria-labelledby="react-tabs-202"></div></div></div></div></div></div><div id="tag/Basic-Authentication" data-section-id="tag/Basic-Authentication" class="sc-eDLKkx hNzKJC"><div class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h1 class="sc-fsYfdN gqLiaw"><a class="sc-csKJxZ fNhImz" href="#tag/Basic-Authentication" aria-label="tag/Basic-Authentication"></a>Basic Authentication</h1></div></div><div class="sc-hLQSwg jSgyLg"><div class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS redoc-markdown " html="<p>API for basic auth user validation.</p>
|
||
"><p>API for basic auth user validation.</p>
|
||
</div></div></div><div id="tag/Basic-Authentication/operation/validateBasicAuth" data-section-id="tag/Basic-Authentication/operation/validateBasicAuth" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/validateBasicAuth" id="operation/validateBasicAuth" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Basic-Authentication/operation/validateBasicAuth" aria-label="tag/Basic-Authentication/operation/validateBasicAuth"></a>validateBasicAuth<!-- --> </h2><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>OK</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>OK</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/userinfo</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/userinfo</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-204" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-205" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-205" aria-labelledby="react-tabs-204"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"tenant"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Software-Module-Types" data-section-id="tag/Software-Module-Types" class="sc-eDLKkx hNzKJC"><div class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h1 class="sc-fsYfdN gqLiaw"><a class="sc-csKJxZ fNhImz" href="#tag/Software-Module-Types" aria-label="tag/Software-Module-Types"></a>Software Module Types</h1></div></div><div class="sc-hLQSwg jSgyLg"><div class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS redoc-markdown " html="<p>REST API for SoftwareModuleTypes CRUD operations.</p>
|
||
"><p>REST API for SoftwareModuleTypes CRUD operations.</p>
|
||
</div></div></div><div id="tag/Software-Module-Types/operation/getSoftwareModuleType" data-section-id="tag/Software-Module-Types/operation/getSoftwareModuleType" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getSoftwareModuleType" id="operation/getSoftwareModuleType" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Software-Module-Types/operation/getSoftwareModuleType" aria-label="tag/Software-Module-Types/operation/getSoftwareModuleType"></a>Return single Software Module Type<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the GET request of retrieving a single software module type. Required Permission: READ_REPOSITORY</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the GET request of retrieving a single software module type. Required Permission: READ_REPOSITORY</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="softwareModuleTypeId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">softwareModuleTypeId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Software Module Type not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Software Module Type not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/softwaremoduletypes/{softwareModuleTypeId}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/softwaremoduletypes/{softwareModuleTypeId}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-206" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-207" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-208" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-209" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-207" aria-labelledby="react-tabs-206"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"createdBy"</span>: <span class="token string">"system"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token number">1682408579390</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408579394</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"Application"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"Updated description."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key"</span>: <span class="token string">"application"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"maxAssignments"</span>: <span class="token number">2147483647</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deleted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremoduletypes/4">https://management-api.host.com/rest/v1/softwaremoduletypes/4</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token number">4</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-209" aria-labelledby="react-tabs-208"></div></div></div></div></div></div><div id="tag/Software-Module-Types/operation/updateSoftwareModuleType" data-section-id="tag/Software-Module-Types/operation/updateSoftwareModuleType" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/updateSoftwareModuleType" id="operation/updateSoftwareModuleType" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Software-Module-Types/operation/updateSoftwareModuleType" aria-label="tag/Software-Module-Types/operation/updateSoftwareModuleType"></a>Update Software Module Type<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the PUT request for a single software module type. Required Permission: UPDATE_REPOSITORY</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the PUT request for a single software module type. Required Permission: UPDATE_REPOSITORY</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="softwareModuleTypeId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">softwareModuleTypeId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><h5 class="sc-irLvIq cnGhhy">Request Body schema: <div class="sc-jIBlqr sc-hhyKGa bjIddV lkwvLJ"><svg class="sc-ilxebA bCxWCn" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div><div class="sc-gUjWJS sc-eKzvBH sc-jnlcPO itHPsH ciWJhv gcZOqF">required</div></h5><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"></div><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="description" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">description</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class="last "><td kind="field" title="colour" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">colour</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Software Module Type not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Software Module Type not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">409<!-- --> </strong><div html="<p>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.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>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.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">415<!-- --> </strong><div html="<p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="put" class="sc-jYnQyy hyHSPQ http-verb put">put</span><span class="sc-fYrVWQ gllLir">/rest/v1/softwaremoduletypes/{softwareModuleTypeId}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/softwaremoduletypes/{softwareModuleTypeId}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Request samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-210" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-211" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-211" aria-labelledby="react-tabs-210"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"Example description"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"colour"</span>: <span class="token string">"rgb(0,0,255"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-212" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-213" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-214" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-215" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-213" aria-labelledby="react-tabs-212"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"createdBy"</span>: <span class="token string">"system"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token number">1682408579390</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408579394</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"Application"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"Updated description."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key"</span>: <span class="token string">"application"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"maxAssignments"</span>: <span class="token number">2147483647</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deleted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremoduletypes/4">https://management-api.host.com/rest/v1/softwaremoduletypes/4</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token number">4</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-215" aria-labelledby="react-tabs-214"></div></div></div></div></div></div><div id="tag/Software-Module-Types/operation/deleteSoftwareModuleType" data-section-id="tag/Software-Module-Types/operation/deleteSoftwareModuleType" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/deleteSoftwareModuleType" id="operation/deleteSoftwareModuleType" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Software-Module-Types/operation/deleteSoftwareModuleType" aria-label="tag/Software-Module-Types/operation/deleteSoftwareModuleType"></a>Delete Software Module Type by Id<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the DELETE request for a single software module type. Required Permission: DELETE_REPOSITORY</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the DELETE request for a single software module type. Required Permission: DELETE_REPOSITORY</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="softwareModuleTypeId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">softwareModuleTypeId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA iSOCsR" disabled=""><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Software Module Type not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Software Module Type not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="delete" class="sc-jYnQyy jUYA-DF http-verb delete">delete</span><span class="sc-fYrVWQ gllLir">/rest/v1/softwaremoduletypes/{softwareModuleTypeId}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/softwaremoduletypes/{softwareModuleTypeId}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-216" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-217" tabindex="0" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-217" aria-labelledby="react-tabs-216"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-dQmiwx jCmKdj">application/json</div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"exceptionClass"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errorCode"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"info"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Software-Module-Types/operation/getTypes" data-section-id="tag/Software-Module-Types/operation/getTypes" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getTypes" id="operation/getTypes" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Software-Module-Types/operation/getTypes" aria-label="tag/Software-Module-Types/operation/getTypes"></a>Return all Software Module Types<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the GET request of retrieving all software module types. Required Permission: READ_REPOSITORY</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the GET request of retrieving all software module types. Required Permission: READ_REPOSITORY</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">query<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="offset" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">offset</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Default:<!-- --> </span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">0</span></div> <div><div html="<p>The paging offset (default is 0)</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The paging offset (default is 0)</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="limit" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">limit</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Default:<!-- --> </span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">50</span></div> <div><div html="<p>The maximum number of entries in a page (default is 50)</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The maximum number of entries in a page (default is 50)</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="sort" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">sort</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The query parameter sort allows to define the sort order for the result of a query. A sort criteria
|
||
consists of the name of a field and the sort direction (ASC for ascending and DESC descending).
|
||
The sequence of the sort criteria (multiple can be used) defines the sort order of the entities
|
||
in the result.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The query parameter sort allows to define the sort order for the result of a query. A sort criteria
|
||
consists of the name of a field and the sort direction (ASC for ascending and DESC descending).
|
||
The sequence of the sort criteria (multiple can be used) defines the sort order of the entities
|
||
in the result.</p>
|
||
</div></div></div></td></tr><tr class="last "><td kind="field" title="q" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">q</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for
|
||
available fields.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for
|
||
available fields.</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/softwaremoduletypes</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/softwaremoduletypes</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-218" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-219" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-220" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-221" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-219" aria-labelledby="react-tabs-218"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"content"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"createdBy"</span>: <span class="token string">"system"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token number">1682408579390</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408579394</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"Application"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"Updated description."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"key"</span>: <span class="token string">"application"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"maxAssignments"</span>: <span class="token number">2147483647</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deleted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremoduletypes/4">https://management-api.host.com/rest/v1/softwaremoduletypes/4</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">4</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"total"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"size"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hreflang"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deprecation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"profile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"templated"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hreflang"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deprecation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"profile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"templated"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-221" aria-labelledby="react-tabs-220"></div></div></div></div></div></div><div id="tag/Software-Module-Types/operation/createSoftwareModuleTypes" data-section-id="tag/Software-Module-Types/operation/createSoftwareModuleTypes" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/createSoftwareModuleTypes" id="operation/createSoftwareModuleTypes" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Software-Module-Types/operation/createSoftwareModuleTypes" aria-label="tag/Software-Module-Types/operation/createSoftwareModuleTypes"></a>Creates new Software Module Types<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the POST request of creating new software module types. The request body must always be a list of module types. Required Permission: CREATE_REPOSITORY</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the POST request of creating new software module types. The request body must always be a list of module types. Required Permission: CREATE_REPOSITORY</p>
|
||
</div></div><h5 class="sc-irLvIq cnGhhy">Request Body schema: <div class="sc-jIBlqr sc-hhyKGa bjIddV lkwvLJ"><svg class="sc-ilxebA bCxWCn" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div><div class="sc-gUjWJS sc-eKzvBH sc-jnlcPO itHPsH ciWJhv gcZOqF">required</div></h5><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"></div><div><div class="sc-bBkKde cplVKI"> Array </div><div class="sc-bbxCgr iZgtJR"><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="description" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">description</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class=""><td kind="field" title="colour" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">colour</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class=""><td kind="field" title="name" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">name</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class=""><td kind="field" title="key" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">key</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class="last "><td kind="field" title="maxAssignments" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">maxAssignments</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div class="sc-iuOOrT hPMvVd"></div></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">201<!-- --> </strong><div html="<p>Successfully created</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully created</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Software Module not found</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Software Module not found</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">409<!-- --> </strong><div html="<p>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.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>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.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">415<!-- --> </strong><div html="<p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="post" class="sc-jYnQyy jBKVIL http-verb post">post</span><span class="sc-fYrVWQ gllLir">/rest/v1/softwaremoduletypes</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/softwaremoduletypes</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Request samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-222" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-223" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-223" aria-labelledby="react-tabs-222"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"Example description"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"colour"</span>: <span class="token string">"rgb(0,0,255"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"Example name"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"key"</span>: <span class="token string">"Example key"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"maxAssignments"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-224" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-225" tabindex="0" data-rttab="true">201</li><li class="tab-error" role="tab" id="react-tabs-226" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-227" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-225" aria-labelledby="react-tabs-224"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"createdBy"</span>: <span class="token string">"system"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token number">1682408579390</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408579394</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"Application"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"Updated description."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"key"</span>: <span class="token string">"application"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"maxAssignments"</span>: <span class="token number">2147483647</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deleted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremoduletypes/4">https://management-api.host.com/rest/v1/softwaremoduletypes/4</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">4</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-227" aria-labelledby="react-tabs-226"></div></div></div></div></div></div><div id="tag/Rollouts" data-section-id="tag/Rollouts" class="sc-eDLKkx hNzKJC"><div class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h1 class="sc-fsYfdN gqLiaw"><a class="sc-csKJxZ fNhImz" href="#tag/Rollouts" aria-label="tag/Rollouts"></a>Rollouts</h1></div></div><div class="sc-hLQSwg jSgyLg"><div class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS redoc-markdown " html="<p>REST API for Rollout CRUD operations.</p>
|
||
"><p>REST API for Rollout CRUD operations.</p>
|
||
</div></div></div><div id="tag/Rollouts/operation/getRollout" data-section-id="tag/Rollouts/operation/getRollout" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getRollout" id="operation/getRollout" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Rollouts/operation/getRollout" aria-label="tag/Rollouts/operation/getRollout"></a>Return single Rollout<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the GET request of retrieving a single rollout. Required Permission: READ_ROLLOUT</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the GET request of retrieving a single rollout. Required Permission: READ_ROLLOUT</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="rolloutId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">rolloutId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Rollout not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Rollout not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/rollouts/{rolloutId}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/rollouts/{rolloutId}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-228" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-229" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-230" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-231" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-229" aria-labelledby="react-tabs-228"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token number">1682408568812</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408568812</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"exampleRollout"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"Rollout for all named targets"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"targetFilterQuery"</span>: <span class="token string">"id==targets-*"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"distributionSetId"</span>: <span class="token number">6</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"creating"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"totalTargets"</span>: <span class="token number">20</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"totalTargetsPerStatus"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"running"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"notstarted"</span>: <span class="token number">20</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"scheduled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"cancelled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"finished"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"error"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"totalGroups"</span>: <span class="token number">5</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"startAt"</span>: <span class="token number">1682408570791</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"forcetime"</span>: <span class="token number">1682408571791</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deleted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"forced"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"start"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/rollouts/6/start">https://management-api.host.com/rest/v1/rollouts/6/start</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"pause"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/rollouts/6/pause">https://management-api.host.com/rest/v1/rollouts/6/pause</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"resume"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/rollouts/6/resume">https://management-api.host.com/rest/v1/rollouts/6/resume</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"triggerNextGroup"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/rollouts/6/triggerNextGroup">https://management-api.host.com/rest/v1/rollouts/6/triggerNextGroup</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"approve"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/rollouts/6/approve">https://management-api.host.com/rest/v1/rollouts/6/approve</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deny"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/rollouts/6/deny">https://management-api.host.com/rest/v1/rollouts/6/deny</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"groups"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/rollouts/6/deploygroups?offset=0&limit=50">https://management-api.host.com/rest/v1/rollouts/6/deploygroups?offset=0&limit=50</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"distributionset"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsets/6">https://management-api.host.com/rest/v1/distributionsets/6</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"bd3a71cb-6c8f-445c-adbb-e221414dcd96:1.0"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/rollouts/6">https://management-api.host.com/rest/v1/rollouts/6</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token number">6</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-231" aria-labelledby="react-tabs-230"></div></div></div></div></div></div><div id="tag/Rollouts/operation/update" data-section-id="tag/Rollouts/operation/update" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/update" id="operation/update" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Rollouts/operation/update" aria-label="tag/Rollouts/operation/update"></a>Update Rollout<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the UPDATE request for a single Rollout. Required permission: UPDATE_ROLLOUT</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the UPDATE request for a single Rollout. Required permission: UPDATE_ROLLOUT</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="rolloutId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">rolloutId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><h5 class="sc-irLvIq cnGhhy">Request Body schema: <div class="sc-jIBlqr sc-hhyKGa bjIddV lkwvLJ"><svg class="sc-ilxebA bCxWCn" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div><div class="sc-gUjWJS sc-eKzvBH sc-jnlcPO itHPsH ciWJhv gcZOqF">required</div></h5><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"></div><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="name" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">name</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class=""><td kind="field" title="description" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">description</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class="last "><td kind="field" title="_links" class="sc-hABBmJ sc-fHejqy sc-jiaSqj cqoAxn hfWKVF gIkRoy"><span class="sc-ifyrAs hIHfpT"></span><button aria-label="expand _links"><span class="property-name">_links</span><svg class="sc-eTNRI jIsRbK" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">object</span><span class="sc-gUjWJS sc-jgraLO itHPsH iUxudT"> (<!-- -->Links<!-- -->) </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Distribution Set not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Distribution Set not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">409<!-- --> </strong><div html="<p>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.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>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.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">415<!-- --> </strong><div html="<p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="put" class="sc-jYnQyy hyHSPQ http-verb put">put</span><span class="sc-fYrVWQ gllLir">/rest/v1/rollouts/{rolloutId}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/rollouts/{rolloutId}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Request samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-232" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-233" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-233" aria-labelledby="react-tabs-232"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"exampleRollout"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"Rollout for all named targets"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-234" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-235" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-236" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-237" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-235" aria-labelledby="react-tabs-234"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/json" selected="">application/json</option><option value="application/hal+json">application/hal+json</option></select><label>application/json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token number">1682408568812</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408568812</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"exampleRollout"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"Rollout for all named targets"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"targetFilterQuery"</span>: <span class="token string">"id==targets-*"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"distributionSetId"</span>: <span class="token number">6</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"creating"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"totalTargets"</span>: <span class="token number">20</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"totalTargetsPerStatus"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"running"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"notstarted"</span>: <span class="token number">20</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"scheduled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"cancelled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"finished"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"error"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"totalGroups"</span>: <span class="token number">5</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"startAt"</span>: <span class="token number">1682408570791</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"forcetime"</span>: <span class="token number">1682408571791</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deleted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"forced"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"start"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/rollouts/6/start">https://management-api.host.com/rest/v1/rollouts/6/start</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"pause"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/rollouts/6/pause">https://management-api.host.com/rest/v1/rollouts/6/pause</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"resume"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/rollouts/6/resume">https://management-api.host.com/rest/v1/rollouts/6/resume</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"triggerNextGroup"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/rollouts/6/triggerNextGroup">https://management-api.host.com/rest/v1/rollouts/6/triggerNextGroup</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"approve"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/rollouts/6/approve">https://management-api.host.com/rest/v1/rollouts/6/approve</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deny"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/rollouts/6/deny">https://management-api.host.com/rest/v1/rollouts/6/deny</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"groups"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/rollouts/6/deploygroups?offset=0&limit=50">https://management-api.host.com/rest/v1/rollouts/6/deploygroups?offset=0&limit=50</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"distributionset"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsets/6">https://management-api.host.com/rest/v1/distributionsets/6</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"bd3a71cb-6c8f-445c-adbb-e221414dcd96:1.0"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/rollouts/6">https://management-api.host.com/rest/v1/rollouts/6</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token number">6</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-237" aria-labelledby="react-tabs-236"></div></div></div></div></div></div><div id="tag/Rollouts/operation/delete" data-section-id="tag/Rollouts/operation/delete" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/delete" id="operation/delete" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Rollouts/operation/delete" aria-label="tag/Rollouts/operation/delete"></a>Delete a Rollout<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the DELETE request of deleting a rollout. Required Permission: DELETE_ROLLOUT</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the DELETE request of deleting a rollout. Required Permission: DELETE_ROLLOUT</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="rolloutId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">rolloutId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA iSOCsR" disabled=""><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Rollout not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Rollout not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="delete" class="sc-jYnQyy jUYA-DF http-verb delete">delete</span><span class="sc-fYrVWQ gllLir">/rest/v1/rollouts/{rolloutId}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/rollouts/{rolloutId}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-238" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-239" tabindex="0" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-239" aria-labelledby="react-tabs-238"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-dQmiwx jCmKdj">application/json</div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"exceptionClass"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errorCode"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"info"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Rollouts/operation/getRollouts" data-section-id="tag/Rollouts/operation/getRollouts" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getRollouts" id="operation/getRollouts" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Rollouts/operation/getRollouts" aria-label="tag/Rollouts/operation/getRollouts"></a>Return all Rollouts<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the GET request of retrieving all rollouts. Required Permission: READ_ROLLOUT</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the GET request of retrieving all rollouts. Required Permission: READ_ROLLOUT</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">query<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="offset" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">offset</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Default:<!-- --> </span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">0</span></div> <div><div html="<p>The paging offset (default is 0)</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The paging offset (default is 0)</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="limit" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">limit</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Default:<!-- --> </span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">50</span></div> <div><div html="<p>The maximum number of entries in a page (default is 50)</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The maximum number of entries in a page (default is 50)</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="sort" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">sort</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The query parameter sort allows to define the sort order for the result of a query. A sort criteria
|
||
consists of the name of a field and the sort direction (ASC for ascending and DESC descending).
|
||
The sequence of the sort criteria (multiple can be used) defines the sort order of the entities
|
||
in the result.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The query parameter sort allows to define the sort order for the result of a query. A sort criteria
|
||
consists of the name of a field and the sort direction (ASC for ascending and DESC descending).
|
||
The sequence of the sort criteria (multiple can be used) defines the sort order of the entities
|
||
in the result.</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="q" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">q</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for
|
||
available fields.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for
|
||
available fields.</p>
|
||
</div></div></div></td></tr><tr class="last "><td kind="field" title="representation" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">representation</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Default:<!-- --> </span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">"compact"</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/rollouts</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/rollouts</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-240" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-241" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-242" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-243" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-241" aria-labelledby="react-tabs-240"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"content"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token number">1682408568812</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408568812</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"exampleRollout"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"Rollout for all named targets"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"targetFilterQuery"</span>: <span class="token string">"id==targets-*"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"distributionSetId"</span>: <span class="token number">6</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"status"</span>: <span class="token string">"creating"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"totalTargets"</span>: <span class="token number">20</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"totalTargetsPerStatus"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"running"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"notstarted"</span>: <span class="token number">20</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"scheduled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"cancelled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"finished"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"error"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"totalGroups"</span>: <span class="token number">5</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"startAt"</span>: <span class="token number">1682408570791</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"forcetime"</span>: <span class="token number">1682408571791</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deleted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"forced"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"start"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/rollouts/6/start">https://management-api.host.com/rest/v1/rollouts/6/start</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"pause"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/rollouts/6/pause">https://management-api.host.com/rest/v1/rollouts/6/pause</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"resume"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/rollouts/6/resume">https://management-api.host.com/rest/v1/rollouts/6/resume</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"triggerNextGroup"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/rollouts/6/triggerNextGroup">https://management-api.host.com/rest/v1/rollouts/6/triggerNextGroup</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"approve"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/rollouts/6/approve">https://management-api.host.com/rest/v1/rollouts/6/approve</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deny"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/rollouts/6/deny">https://management-api.host.com/rest/v1/rollouts/6/deny</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"groups"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/rollouts/6/deploygroups?offset=0&limit=50">https://management-api.host.com/rest/v1/rollouts/6/deploygroups?offset=0&limit=50</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"distributionset"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsets/6">https://management-api.host.com/rest/v1/distributionsets/6</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"bd3a71cb-6c8f-445c-adbb-e221414dcd96:1.0"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/rollouts/6">https://management-api.host.com/rest/v1/rollouts/6</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">6</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"total"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"size"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hreflang"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deprecation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"profile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"templated"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hreflang"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deprecation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"profile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"templated"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-243" aria-labelledby="react-tabs-242"></div></div></div></div></div></div><div id="tag/Rollouts/operation/create" data-section-id="tag/Rollouts/operation/create" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/create" id="operation/create" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Rollouts/operation/create" aria-label="tag/Rollouts/operation/create"></a>Create a new Rollout<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the POST request of creating new rollout. Required Permission: CREATE_ROLLOUT</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the POST request of creating new rollout. Required Permission: CREATE_ROLLOUT</p>
|
||
</div></div><h5 class="sc-irLvIq cnGhhy">Request Body schema: <div class="sc-jIBlqr sc-hhyKGa bjIddV lkwvLJ"><svg class="sc-ilxebA bCxWCn" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div><div class="sc-gUjWJS sc-eKzvBH sc-jnlcPO itHPsH ciWJhv gcZOqF">required</div></h5><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"></div><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="name" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">name</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class=""><td kind="field" title="description" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">description</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class=""><td kind="field" title="successCondition" class="sc-hABBmJ sc-fHejqy sc-jiaSqj cqoAxn hfWKVF gIkRoy"><span class="sc-ifyrAs hIHfpT"></span><button aria-label="expand successCondition"><span class="property-name">successCondition</span><svg class="sc-eTNRI jIsRbK" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">object</span><span class="sc-gUjWJS sc-jgraLO itHPsH iUxudT"> (<!-- -->MgmtRolloutCondition<!-- -->) </span></div> <div><div html="<p>The error condition which takes in place to evaluate if a rollout group encounter errors</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The error condition which takes in place to evaluate if a rollout group encounter errors</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="successAction" class="sc-hABBmJ sc-fHejqy sc-jiaSqj cqoAxn hfWKVF gIkRoy"><span class="sc-ifyrAs hIHfpT"></span><button aria-label="expand successAction"><span class="property-name">successAction</span><svg class="sc-eTNRI jIsRbK" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">object</span><span class="sc-gUjWJS sc-jgraLO itHPsH iUxudT"> (<!-- -->MgmtRolloutSuccessAction<!-- -->) </span></div> <div><div html="<p>The success action which takes in place to execute in case the success action is fulfilled</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The success action which takes in place to execute in case the success action is fulfilled</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="errorCondition" class="sc-hABBmJ sc-fHejqy sc-jiaSqj cqoAxn hfWKVF gIkRoy"><span class="sc-ifyrAs hIHfpT"></span><button aria-label="expand errorCondition"><span class="property-name">errorCondition</span><svg class="sc-eTNRI jIsRbK" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">object</span><span class="sc-gUjWJS sc-jgraLO itHPsH iUxudT"> (<!-- -->MgmtRolloutCondition<!-- -->) </span></div> <div><div html="<p>The error condition which takes in place to evaluate if a rollout group encounter errors</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The error condition which takes in place to evaluate if a rollout group encounter errors</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="errorAction" class="sc-hABBmJ sc-fHejqy sc-jiaSqj cqoAxn hfWKVF gIkRoy"><span class="sc-ifyrAs hIHfpT"></span><button aria-label="expand errorAction"><span class="property-name">errorAction</span><svg class="sc-eTNRI jIsRbK" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">object</span><span class="sc-gUjWJS sc-jgraLO itHPsH iUxudT"> (<!-- -->MgmtRolloutErrorAction<!-- -->) </span></div> <div><div html="<p>The error action which is executed if the error condition is fulfilled</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The error action which is executed if the error condition is fulfilled</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="targetFilterQuery" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">targetFilterQuery</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>Target filter query language expression</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Target filter query language expression</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="distributionSetId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">distributionSetId</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="<p>The ID of distribution set of this rollout</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The ID of distribution set of this rollout</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="amountGroups" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">amountGroups</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div> <div><div html="<p>The amount of groups the rollout should split targets into</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The amount of groups the rollout should split targets into</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="forcetime" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">forcetime</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="<p>Force time in milliseconds</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Force time in milliseconds</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="startAt" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">startAt</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="<p>Start at timestamp of Rollout</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Start at timestamp of Rollout</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="weight" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">weight</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div> <div><div html="<p>Weight of the resulting Actions</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Weight of the resulting Actions</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="dynamic" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">dynamic</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">boolean</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class=""><td kind="field" title="dynamicGroupTemplate" class="sc-hABBmJ sc-fHejqy sc-jiaSqj cqoAxn hfWKVF gIkRoy"><span class="sc-ifyrAs hIHfpT"></span><button aria-label="expand dynamicGroupTemplate"><span class="property-name">dynamicGroupTemplate</span><svg class="sc-eTNRI jIsRbK" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">object</span><span class="sc-gUjWJS sc-jgraLO itHPsH iUxudT"> (<!-- -->MgmtDynamicRolloutGroupTemplate<!-- -->) </span></div> <div><div html="<p>Template for dynamic groups (only if dynamic flag is true)</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Template for dynamic groups (only if dynamic flag is true)</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="confirmationRequired" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">confirmationRequired</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">boolean</span></div> <div><div html="<p>(Available with user consent flow active) If the confirmation is required for this rollout. Value will be used
|
||
if confirmation options are missing in the rollout group definitions. Confirmation is required per default</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>(Available with user consent flow active) If the confirmation is required for this rollout. Value will be used
|
||
if confirmation options are missing in the rollout group definitions. Confirmation is required per default</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="type" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">type</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Enum<!-- -->:</span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">"soft"</span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">"forced"</span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">"timeforced"</span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">"downloadonly"</span> </div> <div><div html="<p>The type of this rollout</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The type of this rollout</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="groups" class="sc-hABBmJ sc-fHejqy sc-jiaSqj cqoAxn hfWKVF gIkRoy"><span class="sc-ifyrAs hIHfpT"></span><button aria-label="expand groups"><span class="property-name">groups</span><svg class="sc-eTNRI jIsRbK" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY">Array of </span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">objects</span><span class="sc-gUjWJS sc-jgraLO itHPsH iUxudT"> (<!-- -->MgmtRolloutGroup<!-- -->) </span></div> <div><div html="<p>The list of group definitions</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The list of group definitions</p>
|
||
</div></div></div></td></tr><tr class="last "><td kind="field" title="_links" class="sc-hABBmJ sc-fHejqy sc-jiaSqj cqoAxn hfWKVF gIkRoy"><span class="sc-ifyrAs hIHfpT"></span><button aria-label="expand _links"><span class="property-name">_links</span><svg class="sc-eTNRI jIsRbK" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">object</span><span class="sc-gUjWJS sc-jgraLO itHPsH iUxudT"> (<!-- -->Links<!-- -->) </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">201<!-- --> </strong><div html="<p>Successfully created</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully created</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">409<!-- --> </strong><div html="<p>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.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>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.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">415<!-- --> </strong><div html="<p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="post" class="sc-jYnQyy jBKVIL http-verb post">post</span><span class="sc-fYrVWQ gllLir">/rest/v1/rollouts</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/rollouts</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Request samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-244" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-245" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-245" aria-labelledby="react-tabs-244"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"distributionSetId"</span>: <span class="token number">6</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"targetFilterQuery"</span>: <span class="token string">"id==targets-*"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"Rollout for all named targets"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"amountGroups"</span>: <span class="token number">5</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"forced"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"successCondition"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"condition"</span>: <span class="token string">"THRESHOLD"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"expression"</span>: <span class="token string">"50"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"successAction"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"expression"</span>: <span class="token string">""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"action"</span>: <span class="token string">"NEXTGROUP"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"exampleRollout"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"forcetime"</span>: <span class="token number">1682408571791</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errorAction"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"expression"</span>: <span class="token string">""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"action"</span>: <span class="token string">"PAUSE"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"confirmationRequired"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errorCondition"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"condition"</span>: <span class="token string">"THRESHOLD"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"expression"</span>: <span class="token string">"80"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"startAt"</span>: <span class="token number">1682408570791</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-246" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-247" tabindex="0" data-rttab="true">201</li><li class="tab-error" role="tab" id="react-tabs-248" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-249" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-247" aria-labelledby="react-tabs-246"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token number">1682408568812</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408568812</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"exampleRollout"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"Rollout for all named targets"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"targetFilterQuery"</span>: <span class="token string">"id==targets-*"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"distributionSetId"</span>: <span class="token number">6</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"creating"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"totalTargets"</span>: <span class="token number">20</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"totalTargetsPerStatus"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"running"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"notstarted"</span>: <span class="token number">20</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"scheduled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"cancelled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"finished"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"error"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"totalGroups"</span>: <span class="token number">5</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"startAt"</span>: <span class="token number">1682408570791</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"forcetime"</span>: <span class="token number">1682408571791</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deleted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"forced"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"start"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/rollouts/6/start">https://management-api.host.com/rest/v1/rollouts/6/start</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"pause"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/rollouts/6/pause">https://management-api.host.com/rest/v1/rollouts/6/pause</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"resume"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/rollouts/6/resume">https://management-api.host.com/rest/v1/rollouts/6/resume</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"triggerNextGroup"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/rollouts/6/triggerNextGroup">https://management-api.host.com/rest/v1/rollouts/6/triggerNextGroup</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"approve"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/rollouts/6/approve">https://management-api.host.com/rest/v1/rollouts/6/approve</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deny"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/rollouts/6/deny">https://management-api.host.com/rest/v1/rollouts/6/deny</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"groups"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/rollouts/6/deploygroups?offset=0&limit=50">https://management-api.host.com/rest/v1/rollouts/6/deploygroups?offset=0&limit=50</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"distributionset"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsets/6">https://management-api.host.com/rest/v1/distributionsets/6</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"bd3a71cb-6c8f-445c-adbb-e221414dcd96:1.0"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/rollouts/6">https://management-api.host.com/rest/v1/rollouts/6</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token number">6</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-249" aria-labelledby="react-tabs-248"></div></div></div></div></div></div><div id="tag/Rollouts/operation/triggerNextGroup" data-section-id="tag/Rollouts/operation/triggerNextGroup" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/triggerNextGroup" id="operation/triggerNextGroup" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Rollouts/operation/triggerNextGroup" aria-label="tag/Rollouts/operation/triggerNextGroup"></a>Force trigger processing next group of a Rollout<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the POST request of triggering the next group of a rollout. Required Permission: UPDATE_ROLLOUT</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the POST request of triggering the next group of a rollout. Required Permission: UPDATE_ROLLOUT</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="rolloutId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">rolloutId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA iSOCsR" disabled=""><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="post" class="sc-jYnQyy jBKVIL http-verb post">post</span><span class="sc-fYrVWQ gllLir">/rest/v1/rollouts/{rolloutId}/triggerNextGroup</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/rollouts/{rolloutId}/triggerNextGroup</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-250" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-251" tabindex="0" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-251" aria-labelledby="react-tabs-250"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-dQmiwx jCmKdj">application/json</div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"exceptionClass"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errorCode"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"info"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Rollouts/operation/start" data-section-id="tag/Rollouts/operation/start" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/start" id="operation/start" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Rollouts/operation/start" aria-label="tag/Rollouts/operation/start"></a>Start a Rollout<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the POST request of starting a created rollout. Required Permission: HANDLE_ROLLOUT</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the POST request of starting a created rollout. Required Permission: HANDLE_ROLLOUT</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="rolloutId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">rolloutId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA iSOCsR" disabled=""><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="post" class="sc-jYnQyy jBKVIL http-verb post">post</span><span class="sc-fYrVWQ gllLir">/rest/v1/rollouts/{rolloutId}/start</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/rollouts/{rolloutId}/start</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-252" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-253" tabindex="0" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-253" aria-labelledby="react-tabs-252"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-dQmiwx jCmKdj">application/json</div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"exceptionClass"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errorCode"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"info"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Rollouts/operation/retryRollout" data-section-id="tag/Rollouts/operation/retryRollout" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/retryRollout" id="operation/retryRollout" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Rollouts/operation/retryRollout" aria-label="tag/Rollouts/operation/retryRollout"></a>Retry a rollout<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the POST request of retrying a rollout. Required Permission: CREATE_ROLLOUT</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the POST request of retrying a rollout. Required Permission: CREATE_ROLLOUT</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="rolloutId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">rolloutId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">201<!-- --> </strong><div html="<p>Successfully created</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully created</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Rollout not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Rollout not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="post" class="sc-jYnQyy jBKVIL http-verb post">post</span><span class="sc-fYrVWQ gllLir">/rest/v1/rollouts/{rolloutId}/retry</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/rollouts/{rolloutId}/retry</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-254" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-255" tabindex="0" data-rttab="true">201</li><li class="tab-error" role="tab" id="react-tabs-256" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-257" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-255" aria-labelledby="react-tabs-254"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token number">1682408568812</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408568812</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"exampleRollout"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"Rollout for all named targets"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"targetFilterQuery"</span>: <span class="token string">"id==targets-*"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"distributionSetId"</span>: <span class="token number">6</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"creating"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"totalTargets"</span>: <span class="token number">20</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"totalTargetsPerStatus"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"running"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"notstarted"</span>: <span class="token number">20</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"scheduled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"cancelled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"finished"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"error"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"totalGroups"</span>: <span class="token number">5</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"startAt"</span>: <span class="token number">1682408570791</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"forcetime"</span>: <span class="token number">1682408571791</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deleted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"forced"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"start"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/rollouts/6/start">https://management-api.host.com/rest/v1/rollouts/6/start</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"pause"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/rollouts/6/pause">https://management-api.host.com/rest/v1/rollouts/6/pause</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"resume"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/rollouts/6/resume">https://management-api.host.com/rest/v1/rollouts/6/resume</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"triggerNextGroup"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/rollouts/6/triggerNextGroup">https://management-api.host.com/rest/v1/rollouts/6/triggerNextGroup</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"approve"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/rollouts/6/approve">https://management-api.host.com/rest/v1/rollouts/6/approve</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deny"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/rollouts/6/deny">https://management-api.host.com/rest/v1/rollouts/6/deny</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"groups"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/rollouts/6/deploygroups?offset=0&limit=50">https://management-api.host.com/rest/v1/rollouts/6/deploygroups?offset=0&limit=50</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"distributionset"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsets/6">https://management-api.host.com/rest/v1/distributionsets/6</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"bd3a71cb-6c8f-445c-adbb-e221414dcd96:1.0"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/rollouts/6">https://management-api.host.com/rest/v1/rollouts/6</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token number">6</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-257" aria-labelledby="react-tabs-256"></div></div></div></div></div></div><div id="tag/Rollouts/operation/resume" data-section-id="tag/Rollouts/operation/resume" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/resume" id="operation/resume" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Rollouts/operation/resume" aria-label="tag/Rollouts/operation/resume"></a>Resume a Rollout<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the POST request of resuming a paused rollout. Required Permission: HANDLE_ROLLOUT</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the POST request of resuming a paused rollout. Required Permission: HANDLE_ROLLOUT</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="rolloutId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">rolloutId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA iSOCsR" disabled=""><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="post" class="sc-jYnQyy jBKVIL http-verb post">post</span><span class="sc-fYrVWQ gllLir">/rest/v1/rollouts/{rolloutId}/resume</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/rollouts/{rolloutId}/resume</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-258" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-259" tabindex="0" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-259" aria-labelledby="react-tabs-258"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-dQmiwx jCmKdj">application/json</div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"exceptionClass"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errorCode"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"info"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Rollouts/operation/pause" data-section-id="tag/Rollouts/operation/pause" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/pause" id="operation/pause" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Rollouts/operation/pause" aria-label="tag/Rollouts/operation/pause"></a>Pause a Rollout<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the POST request of pausing a running rollout. Required Permission: HANDLE_ROLLOUT</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the POST request of pausing a running rollout. Required Permission: HANDLE_ROLLOUT</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="rolloutId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">rolloutId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA iSOCsR" disabled=""><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="post" class="sc-jYnQyy jBKVIL http-verb post">post</span><span class="sc-fYrVWQ gllLir">/rest/v1/rollouts/{rolloutId}/pause</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/rollouts/{rolloutId}/pause</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-260" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-261" tabindex="0" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-261" aria-labelledby="react-tabs-260"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-dQmiwx jCmKdj">application/json</div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"exceptionClass"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errorCode"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"info"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Rollouts/operation/deny" data-section-id="tag/Rollouts/operation/deny" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/deny" id="operation/deny" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Rollouts/operation/deny" aria-label="tag/Rollouts/operation/deny"></a>Deny a Rollout<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the POST request of denying a created rollout. Only possible if approval workflow is enabled in system configuration and rollout is in state WAITING_FOR_APPROVAL. Required Permission: APPROVE_ROLLOUT</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the POST request of denying a created rollout. Only possible if approval workflow is enabled in system configuration and rollout is in state WAITING_FOR_APPROVAL. Required Permission: APPROVE_ROLLOUT</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="rolloutId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">rolloutId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h5 class="sc-irLvIq cnGhhy">query<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="remark" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">remark</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA iSOCsR" disabled=""><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="post" class="sc-jYnQyy jBKVIL http-verb post">post</span><span class="sc-fYrVWQ gllLir">/rest/v1/rollouts/{rolloutId}/deny</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/rollouts/{rolloutId}/deny</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-262" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-263" tabindex="0" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-263" aria-labelledby="react-tabs-262"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-dQmiwx jCmKdj">application/json</div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"exceptionClass"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errorCode"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"info"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Rollouts/operation/approve" data-section-id="tag/Rollouts/operation/approve" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/approve" id="operation/approve" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Rollouts/operation/approve" aria-label="tag/Rollouts/operation/approve"></a>Approve a Rollout<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the POST request of approving a created rollout. Only possible if approval workflow is enabled in system configuration and rollout is in state WAITING_FOR_APPROVAL. Required Permission: APPROVE_ROLLOUT</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the POST request of approving a created rollout. Only possible if approval workflow is enabled in system configuration and rollout is in state WAITING_FOR_APPROVAL. Required Permission: APPROVE_ROLLOUT</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="rolloutId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">rolloutId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h5 class="sc-irLvIq cnGhhy">query<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="remark" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">remark</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA iSOCsR" disabled=""><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="post" class="sc-jYnQyy jBKVIL http-verb post">post</span><span class="sc-fYrVWQ gllLir">/rest/v1/rollouts/{rolloutId}/approve</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/rollouts/{rolloutId}/approve</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-264" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-265" tabindex="0" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-265" aria-labelledby="react-tabs-264"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-dQmiwx jCmKdj">application/json</div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"exceptionClass"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errorCode"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"info"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Rollouts/operation/getRolloutGroups" data-section-id="tag/Rollouts/operation/getRolloutGroups" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getRolloutGroups" id="operation/getRolloutGroups" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Rollouts/operation/getRolloutGroups" aria-label="tag/Rollouts/operation/getRolloutGroups"></a>Return all rollout groups referred to a Rollout<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the GET request of retrieving all deploy groups of a specific rollout. Required Permission: READ_ROLLOUT</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the GET request of retrieving all deploy groups of a specific rollout. Required Permission: READ_ROLLOUT</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="rolloutId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">rolloutId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h5 class="sc-irLvIq cnGhhy">query<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="offset" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">offset</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Default:<!-- --> </span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">0</span></div> <div><div html="<p>The paging offset (default is 0)</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The paging offset (default is 0)</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="limit" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">limit</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Default:<!-- --> </span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">50</span></div> <div><div html="<p>The maximum number of entries in a page (default is 50)</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The maximum number of entries in a page (default is 50)</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="sort" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">sort</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The query parameter sort allows to define the sort order for the result of a query. A sort criteria
|
||
consists of the name of a field and the sort direction (ASC for ascending and DESC descending).
|
||
The sequence of the sort criteria (multiple can be used) defines the sort order of the entities
|
||
in the result.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The query parameter sort allows to define the sort order for the result of a query. A sort criteria
|
||
consists of the name of a field and the sort direction (ASC for ascending and DESC descending).
|
||
The sequence of the sort criteria (multiple can be used) defines the sort order of the entities
|
||
in the result.</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="q" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">q</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for
|
||
available fields.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for
|
||
available fields.</p>
|
||
</div></div></div></td></tr><tr class="last "><td kind="field" title="representation" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">representation</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Default:<!-- --> </span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">"compact"</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Rollout not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Rollout not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/rollouts/{rolloutId}/deploygroups</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/rollouts/{rolloutId}/deploygroups</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-266" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-267" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-268" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-269" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-267" aria-labelledby="react-tabs-266"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"content"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token number">1682408569768</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408569795</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"group-1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"group-1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"successCondition"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"condition"</span>: <span class="token string">"THRESHOLD"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"expression"</span>: <span class="token string">"10"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"successAction"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"action"</span>: <span class="token string">"NEXTGROUP"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"expression"</span>: <span class="token string">""</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"errorCondition"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"condition"</span>: <span class="token string">"THRESHOLD"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"expression"</span>: <span class="token string">"50"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"errorAction"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"action"</span>: <span class="token string">"PAUSE"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"expression"</span>: <span class="token string">""</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"targetFilterQuery"</span>: <span class="token string">""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"targetPercentage"</span>: <span class="token number">20</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"confirmationRequired"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"status"</span>: <span class="token string">"ready"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"totalTargets"</span>: <span class="token number">4</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"totalTargetsPerStatus"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"running"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"notstarted"</span>: <span class="token number">4</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"scheduled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"cancelled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"finished"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"error"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/rollouts/17/deploygroups/78">https://management-api.host.com/rest/v1/rollouts/17/deploygroups/78</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">78</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"total"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"size"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hreflang"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deprecation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"profile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"templated"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hreflang"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deprecation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"profile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"templated"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-269" aria-labelledby="react-tabs-268"></div></div></div></div></div></div><div id="tag/Rollouts/operation/getRolloutGroup" data-section-id="tag/Rollouts/operation/getRolloutGroup" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getRolloutGroup" id="operation/getRolloutGroup" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Rollouts/operation/getRolloutGroup" aria-label="tag/Rollouts/operation/getRolloutGroup"></a>Return single rollout group<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the GET request of a single deploy group of a specific rollout. Required Permission: READ_ROLLOUT</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the GET request of a single deploy group of a specific rollout. Required Permission: READ_ROLLOUT</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="rolloutId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">rolloutId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class="last "><td kind="field" title="groupId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">groupId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Rollout not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Rollout not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/rollouts/{rolloutId}/deploygroups/{groupId}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/rollouts/{rolloutId}/deploygroups/{groupId}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-270" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-271" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-272" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-273" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-271" aria-labelledby="react-tabs-270"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token number">1682408569768</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408569795</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"group-1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"group-1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"successCondition"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"condition"</span>: <span class="token string">"THRESHOLD"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"expression"</span>: <span class="token string">"10"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"successAction"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"action"</span>: <span class="token string">"NEXTGROUP"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"expression"</span>: <span class="token string">""</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errorCondition"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"condition"</span>: <span class="token string">"THRESHOLD"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"expression"</span>: <span class="token string">"50"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errorAction"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"action"</span>: <span class="token string">"PAUSE"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"expression"</span>: <span class="token string">""</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"targetFilterQuery"</span>: <span class="token string">""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"targetPercentage"</span>: <span class="token number">20</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"confirmationRequired"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"ready"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"totalTargets"</span>: <span class="token number">4</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"totalTargetsPerStatus"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"running"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"notstarted"</span>: <span class="token number">4</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"scheduled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"cancelled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"finished"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"error"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/rollouts/17/deploygroups/78">https://management-api.host.com/rest/v1/rollouts/17/deploygroups/78</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token number">78</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-273" aria-labelledby="react-tabs-272"></div></div></div></div></div></div><div id="tag/Rollouts/operation/getRolloutGroupTargets" data-section-id="tag/Rollouts/operation/getRolloutGroupTargets" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getRolloutGroupTargets" id="operation/getRolloutGroupTargets" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Rollouts/operation/getRolloutGroupTargets" aria-label="tag/Rollouts/operation/getRolloutGroupTargets"></a>Return all targets related to a specific rollout group<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the GET request of retrieving all targets of a single deploy group of a specific rollout. Required Permissions: READ_ROLLOUT, READ_TARGET.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the GET request of retrieving all targets of a single deploy group of a specific rollout. Required Permissions: READ_ROLLOUT, READ_TARGET.</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="rolloutId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">rolloutId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class="last "><td kind="field" title="groupId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">groupId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h5 class="sc-irLvIq cnGhhy">query<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="offset" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">offset</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Default:<!-- --> </span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">0</span></div> <div><div html="<p>The paging offset (default is 0)</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The paging offset (default is 0)</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="limit" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">limit</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Default:<!-- --> </span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">50</span></div> <div><div html="<p>The maximum number of entries in a page (default is 50)</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The maximum number of entries in a page (default is 50)</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="sort" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">sort</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The query parameter sort allows to define the sort order for the result of a query. A sort criteria
|
||
consists of the name of a field and the sort direction (ASC for ascending and DESC descending).
|
||
The sequence of the sort criteria (multiple can be used) defines the sort order of the entities
|
||
in the result.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The query parameter sort allows to define the sort order for the result of a query. A sort criteria
|
||
consists of the name of a field and the sort direction (ASC for ascending and DESC descending).
|
||
The sequence of the sort criteria (multiple can be used) defines the sort order of the entities
|
||
in the result.</p>
|
||
</div></div></div></td></tr><tr class="last "><td kind="field" title="q" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">q</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for
|
||
available fields.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for
|
||
available fields.</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Rollout not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Rollout not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/rollouts/{rolloutId}/deploygroups/{groupId}/targets</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/rollouts/{rolloutId}/deploygroups/{groupId}/targets</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-274" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-275" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-276" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-277" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-275" aria-labelledby="react-tabs-274"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"content"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token number">1682408577979</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408577988</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"137"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"My name is 137"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"controllerId"</span>: <span class="token string">"137"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"updateStatus"</span>: <span class="token string">"in_sync"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastControllerRequestAt"</span>: <span class="token number">1682408577978</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"installedAt"</span>: <span class="token number">1682408577987</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ipAddress"</span>: <span class="token string">"192.168.0.1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"address"</span>: <span class="token string">"</span><a href="http://192.168.0.1">http://192.168.0.1</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"pollStatus"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"lastRequestAt"</span>: <span class="token number">1682408577978</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"nextExpectedRequestAt"</span>: <span class="token number">1682451777978</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"overdue"</span>: <span class="token boolean">false</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"securityToken"</span>: <span class="token string">"949f1c3487125467464a960d750373c1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"requestAttributes"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"targetType"</span>: <span class="token number">13</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"targetTypeName"</span>: <span class="token string">"defaultType"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"autoConfirmActive"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/137">https://management-api.host.com/rest/v1/targets/137</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"assignedDS"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/137/assignedDS">https://management-api.host.com/rest/v1/targets/137/assignedDS</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"installedDS"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/137/installedDS">https://management-api.host.com/rest/v1/targets/137/installedDS</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"attributes"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/137/attributes">https://management-api.host.com/rest/v1/targets/137/attributes</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"actions"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/137/actions?offset=0&limit=50&sort=id%253ADESC">https://management-api.host.com/rest/v1/targets/137/actions?offset=0&limit=50&sort=id%3ADESC</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/137/metadata?offset=0&limit=50">https://management-api.host.com/rest/v1/targets/137/metadata?offset=0&limit=50</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"targetType"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targettypes/13">https://management-api.host.com/rest/v1/targettypes/13</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"autoConfirm"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/137/autoConfirm">https://management-api.host.com/rest/v1/targets/137/autoConfirm</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"total"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"size"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hreflang"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deprecation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"profile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"templated"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hreflang"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deprecation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"profile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"templated"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-277" aria-labelledby="react-tabs-276"></div></div></div></div></div></div><div id="tag/Target-Types" data-section-id="tag/Target-Types" class="sc-eDLKkx hNzKJC"><div class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h1 class="sc-fsYfdN gqLiaw"><a class="sc-csKJxZ fNhImz" href="#tag/Target-Types" aria-label="tag/Target-Types"></a>Target Types</h1></div></div><div class="sc-hLQSwg jSgyLg"><div class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS redoc-markdown " html="<p>REST API for Target Type CRUD operations.</p>
|
||
"><p>REST API for Target Type CRUD operations.</p>
|
||
</div></div></div><div id="tag/Target-Types/operation/getTargetType" data-section-id="tag/Target-Types/operation/getTargetType" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getTargetType" id="operation/getTargetType" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Target-Types/operation/getTargetType" aria-label="tag/Target-Types/operation/getTargetType"></a>Return target type by id<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the GET request of retrieving a single target type</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the GET request of retrieving a single target type</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="targetTypeId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">targetTypeId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Target type not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Target type not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/targettypes/{targetTypeId}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/targettypes/{targetTypeId}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-278" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-279" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-280" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-281" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-279" aria-labelledby="react-tabs-278"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token number">1682408564546</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408564546</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"TargetType"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"TargetType description"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"colour"</span>: <span class="token string">"#000000"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targettypes/8">https://management-api.host.com/rest/v1/targettypes/8</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"compatibledistributionsettypes"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targettypes/8/compatibledistributionsettypes">https://management-api.host.com/rest/v1/targettypes/8/compatibledistributionsettypes</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token number">8</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-281" aria-labelledby="react-tabs-280"></div></div></div></div></div></div><div id="tag/Target-Types/operation/updateTargetType" data-section-id="tag/Target-Types/operation/updateTargetType" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/updateTargetType" id="operation/updateTargetType" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Target-Types/operation/updateTargetType" aria-label="tag/Target-Types/operation/updateTargetType"></a>Update target type by id<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the PUT request for a single target type. Required Permission: UPDATE_TARGET</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the PUT request for a single target type. Required Permission: UPDATE_TARGET</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="targetTypeId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">targetTypeId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><h5 class="sc-irLvIq cnGhhy">Request Body schema: <div class="sc-jIBlqr sc-hhyKGa bjIddV lkwvLJ"><svg class="sc-ilxebA bCxWCn" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div><div class="sc-gUjWJS sc-eKzvBH sc-jnlcPO itHPsH ciWJhv gcZOqF">required</div></h5><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"></div><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="name" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">name</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The name of the entity</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The name of the entity</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="description" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">description</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The description of the entity</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The description of the entity</p>
|
||
</div></div></div></td></tr><tr class="last "><td kind="field" title="colour" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">colour</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The colour of the entity</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The colour of the entity</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Target type not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Target type not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">409<!-- --> </strong><div html="<p>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.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>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.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">415<!-- --> </strong><div html="<p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="put" class="sc-jYnQyy hyHSPQ http-verb put">put</span><span class="sc-fYrVWQ gllLir">/rest/v1/targettypes/{targetTypeId}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/targettypes/{targetTypeId}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Request samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-282" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-283" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-283" aria-labelledby="react-tabs-282"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"updatedTypeName"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"an updated description"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"colour"</span>: <span class="token string">"#aaafff"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-284" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-285" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-286" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-287" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-285" aria-labelledby="react-tabs-284"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token number">1682408564546</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408564546</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"TargetType"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"TargetType description"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"colour"</span>: <span class="token string">"#000000"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targettypes/8">https://management-api.host.com/rest/v1/targettypes/8</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"compatibledistributionsettypes"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targettypes/8/compatibledistributionsettypes">https://management-api.host.com/rest/v1/targettypes/8/compatibledistributionsettypes</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token number">8</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-287" aria-labelledby="react-tabs-286"></div></div></div></div></div></div><div id="tag/Target-Types/operation/deleteTargetType" data-section-id="tag/Target-Types/operation/deleteTargetType" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/deleteTargetType" id="operation/deleteTargetType" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Target-Types/operation/deleteTargetType" aria-label="tag/Target-Types/operation/deleteTargetType"></a>Delete target type by id<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the DELETE request for a single target type. Required Permission: DELETE_TARGET</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the DELETE request for a single target type. Required Permission: DELETE_TARGET</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="targetTypeId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">targetTypeId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA iSOCsR" disabled=""><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Target type not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Target type not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="delete" class="sc-jYnQyy jUYA-DF http-verb delete">delete</span><span class="sc-fYrVWQ gllLir">/rest/v1/targettypes/{targetTypeId}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/targettypes/{targetTypeId}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-288" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-289" tabindex="0" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-289" aria-labelledby="react-tabs-288"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-dQmiwx jCmKdj">application/json</div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"exceptionClass"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errorCode"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"info"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Target-Types/operation/getTargetTypes" data-section-id="tag/Target-Types/operation/getTargetTypes" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getTargetTypes" id="operation/getTargetTypes" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Target-Types/operation/getTargetTypes" aria-label="tag/Target-Types/operation/getTargetTypes"></a>Return all target types<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the GET request of retrieving all target types.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the GET request of retrieving all target types.</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">query<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="offset" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">offset</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Default:<!-- --> </span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">0</span></div> <div><div html="<p>The paging offset (default is 0)</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The paging offset (default is 0)</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="limit" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">limit</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Default:<!-- --> </span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">50</span></div> <div><div html="<p>The maximum number of entries in a page (default is 50)</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The maximum number of entries in a page (default is 50)</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="sort" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">sort</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The query parameter sort allows to define the sort order for the result of a query. A sort criteria
|
||
consists of the name of a field and the sort direction (ASC for ascending and DESC descending).
|
||
The sequence of the sort criteria (multiple can be used) defines the sort order of the entities
|
||
in the result.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The query parameter sort allows to define the sort order for the result of a query. A sort criteria
|
||
consists of the name of a field and the sort direction (ASC for ascending and DESC descending).
|
||
The sequence of the sort criteria (multiple can be used) defines the sort order of the entities
|
||
in the result.</p>
|
||
</div></div></div></td></tr><tr class="last "><td kind="field" title="q" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">q</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for
|
||
available fields.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for
|
||
available fields.</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/targettypes</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/targettypes</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-290" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-291" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-292" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-293" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-291" aria-labelledby="react-tabs-290"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"content"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token number">1682408564546</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408564546</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"TargetType"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"TargetType description"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"colour"</span>: <span class="token string">"#000000"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targettypes/8">https://management-api.host.com/rest/v1/targettypes/8</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"compatibledistributionsettypes"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targettypes/8/compatibledistributionsettypes">https://management-api.host.com/rest/v1/targettypes/8/compatibledistributionsettypes</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">8</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"total"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"size"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hreflang"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deprecation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"profile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"templated"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hreflang"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deprecation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"profile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"templated"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-293" aria-labelledby="react-tabs-292"></div></div></div></div></div></div><div id="tag/Target-Types/operation/createTargetTypes" data-section-id="tag/Target-Types/operation/createTargetTypes" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/createTargetTypes" id="operation/createTargetTypes" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Target-Types/operation/createTargetTypes" aria-label="tag/Target-Types/operation/createTargetTypes"></a>Create target types<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the POST request for creating new target types. The request body must always be a list of types. Required Permission: CREATE_TARGET</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the POST request for creating new target types. The request body must always be a list of types. Required Permission: CREATE_TARGET</p>
|
||
</div></div><h5 class="sc-irLvIq cnGhhy">Request Body schema: <div class="sc-jIBlqr sc-hhyKGa bjIddV lkwvLJ"><svg class="sc-ilxebA bCxWCn" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div><div class="sc-gUjWJS sc-eKzvBH sc-jnlcPO itHPsH ciWJhv gcZOqF">required</div></h5><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"></div><div><div class="sc-bBkKde cplVKI"> Array </div><div class="sc-bbxCgr iZgtJR"><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="name" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">name</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The name of the entity</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The name of the entity</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="description" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">description</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The description of the entity</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The description of the entity</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="colour" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">colour</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The colour of the entity</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The colour of the entity</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="key" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">key</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>Target type key</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Target type key</p>
|
||
</div></div></div></td></tr><tr class="last "><td kind="field" title="compatibledistributionsettypes" class="sc-hABBmJ sc-fHejqy sc-jiaSqj cqoAxn hfWKVF gIkRoy"><span class="sc-ifyrAs hIHfpT"></span><button aria-label="expand compatibledistributionsettypes"><span class="property-name">compatibledistributionsettypes</span><svg class="sc-eTNRI jIsRbK" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY">Array of </span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">objects</span><span class="sc-gUjWJS sc-jgraLO itHPsH iUxudT"> (<!-- -->MgmtDistributionSetTypeAssignment<!-- -->) </span></div> <div><div html="<p>Array of distribution set types that are compatible to that target type</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Array of distribution set types that are compatible to that target type</p>
|
||
</div></div></div></td></tr></tbody></table></div><div class="sc-iuOOrT hPMvVd"></div></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">201<!-- --> </strong><div html="<p>Successfully created</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully created</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Target type not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Target type not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">409<!-- --> </strong><div html="<p>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.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>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.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">415<!-- --> </strong><div html="<p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="post" class="sc-jYnQyy jBKVIL http-verb post">post</span><span class="sc-fYrVWQ gllLir">/rest/v1/targettypes</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/targettypes</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Request samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-294" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-295" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-295" aria-labelledby="react-tabs-294"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"updatedTypeName"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"an updated description"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"colour"</span>: <span class="token string">"#aaafff"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"key"</span>: <span class="token string">"id.t23"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"compatibledistributionsettypes"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">108</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-296" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-297" tabindex="0" data-rttab="true">201</li><li class="tab-error" role="tab" id="react-tabs-298" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-299" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-297" aria-labelledby="react-tabs-296"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token number">1682408564546</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408564546</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"TargetType"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"TargetType description"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"colour"</span>: <span class="token string">"#000000"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targettypes/8">https://management-api.host.com/rest/v1/targettypes/8</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"compatibledistributionsettypes"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targettypes/8/compatibledistributionsettypes">https://management-api.host.com/rest/v1/targettypes/8/compatibledistributionsettypes</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">8</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-299" aria-labelledby="react-tabs-298"></div></div></div></div></div></div><div id="tag/Target-Types/operation/getCompatibleDistributionSets" data-section-id="tag/Target-Types/operation/getCompatibleDistributionSets" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getCompatibleDistributionSets" id="operation/getCompatibleDistributionSets" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Target-Types/operation/getCompatibleDistributionSets" aria-label="tag/Target-Types/operation/getCompatibleDistributionSets"></a>Return list of compatible distribution set types<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the GET request of retrieving the list of compatible distribution set types in that target type. Required Permission: READ_TARGET, READ_REPOSITORY</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the GET request of retrieving the list of compatible distribution set types in that target type. Required Permission: READ_TARGET, READ_REPOSITORY</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="targetTypeId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">targetTypeId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Distribution set type was not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Distribution set type was not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/targettypes/{targetTypeId}/compatibledistributionsettypes</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/targettypes/{targetTypeId}/compatibledistributionsettypes</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-300" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-301" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-302" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-303" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-301" aria-labelledby="react-tabs-300"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token number">1682408579418</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408579459</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"OS (FW) mandatory, runtime (FW) and app (SW) optional"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"Desc1234"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"key"</span>: <span class="token string">"test_default_ds_type"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deleted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"colour"</span>: <span class="token string">"rgb(86,37,99)"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsettypes/14">https://management-api.host.com/rest/v1/distributionsettypes/14</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"mandatorymodules"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsettypes/14/mandatorymoduletypes">https://management-api.host.com/rest/v1/distributionsettypes/14/mandatorymoduletypes</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"optionalmodules"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsettypes/14/optionalmoduletypes">https://management-api.host.com/rest/v1/distributionsettypes/14/optionalmoduletypes</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">14</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-303" aria-labelledby="react-tabs-302"></div></div></div></div></div></div><div id="tag/Target-Types/operation/addCompatibleDistributionSets" data-section-id="tag/Target-Types/operation/addCompatibleDistributionSets" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/addCompatibleDistributionSets" id="operation/addCompatibleDistributionSets" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Target-Types/operation/addCompatibleDistributionSets" aria-label="tag/Target-Types/operation/addCompatibleDistributionSets"></a>Adding compatibility of a distribution set type to a target type<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the POST request for adding compatible distribution set types to a target type. Required Permission: UPDATE_TARGET and READ_REPOSITORY</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the POST request for adding compatible distribution set types to a target type. Required Permission: UPDATE_TARGET and READ_REPOSITORY</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="targetTypeId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">targetTypeId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><h5 class="sc-irLvIq cnGhhy">Request Body schema: <div class="sc-jIBlqr sc-hhyKGa bjIddV lkwvLJ"><svg class="sc-ilxebA bCxWCn" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div><div class="sc-gUjWJS sc-eKzvBH sc-jnlcPO itHPsH ciWJhv gcZOqF">required</div></h5><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"></div><div><div class="sc-bBkKde cplVKI"> Array </div><div class="sc-bbxCgr iZgtJR"><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="id" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">id</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div class="sc-iuOOrT hPMvVd"></div></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA iSOCsR" disabled=""><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Distribution set type was not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Distribution set type was not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">409<!-- --> </strong><div html="<p>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.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>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.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">415<!-- --> </strong><div html="<p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="post" class="sc-jYnQyy jBKVIL http-verb post">post</span><span class="sc-fYrVWQ gllLir">/rest/v1/targettypes/{targetTypeId}/compatibledistributionsettypes</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/targettypes/{targetTypeId}/compatibledistributionsettypes</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Request samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-304" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-305" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-305" aria-labelledby="react-tabs-304"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">108</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-306" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-307" tabindex="0" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-307" aria-labelledby="react-tabs-306"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-dQmiwx jCmKdj">application/json</div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"exceptionClass"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errorCode"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"info"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Target-Types/operation/removeCompatibleDistributionSet" data-section-id="tag/Target-Types/operation/removeCompatibleDistributionSet" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/removeCompatibleDistributionSet" id="operation/removeCompatibleDistributionSet" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Target-Types/operation/removeCompatibleDistributionSet" aria-label="tag/Target-Types/operation/removeCompatibleDistributionSet"></a>Remove compatibility of distribution set type from the target type<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the DELETE request for removing a distribution set type from a single target type. Required Permission: UPDATE_TARGET and READ_REPOSITORY</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the DELETE request for removing a distribution set type from a single target type. Required Permission: UPDATE_TARGET and READ_REPOSITORY</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="targetTypeId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">targetTypeId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class="last "><td kind="field" title="distributionSetTypeId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">distributionSetTypeId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA iSOCsR" disabled=""><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Distribution set type was not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Distribution set type was not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="delete" class="sc-jYnQyy jUYA-DF http-verb delete">delete</span><span class="sc-fYrVWQ gllLir">/rest/v1/targettypes/{targetTypeId}/compatibledistributionsettypes/{distributionSetTypeId}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/targettypes/{targetTypeId}/compatibledistributionsettypes/{distributionSetTypeId}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-308" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-309" tabindex="0" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-309" aria-labelledby="react-tabs-308"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-dQmiwx jCmKdj">application/json</div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"exceptionClass"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errorCode"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"info"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Software-Modules" data-section-id="tag/Software-Modules" class="sc-eDLKkx hNzKJC"><div class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h1 class="sc-fsYfdN gqLiaw"><a class="sc-csKJxZ fNhImz" href="#tag/Software-Modules" aria-label="tag/Software-Modules"></a>Software Modules</h1></div></div><div class="sc-hLQSwg jSgyLg"><div class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS redoc-markdown " html="<p>REST API for SoftwareModule and related Artifact CRUD operations.</p>
|
||
"><p>REST API for SoftwareModule and related Artifact CRUD operations.</p>
|
||
</div></div></div><div id="tag/Software-Modules/operation/getSoftwareModule" data-section-id="tag/Software-Modules/operation/getSoftwareModule" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getSoftwareModule" id="operation/getSoftwareModule" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Software-Modules/operation/getSoftwareModule" aria-label="tag/Software-Modules/operation/getSoftwareModule"></a>Return Software Module by id<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the GET request of retrieving a single softwaremodule. Required Permission: READ_REPOSITORY</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the GET request of retrieving a single softwaremodule. Required Permission: READ_REPOSITORY</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="softwareModuleId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">softwareModuleId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Software Module not found </p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Software Module not found </p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/softwaremodules/{softwareModuleId}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/softwaremodules/{softwareModuleId}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-310" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-311" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-312" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-313" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-311" aria-labelledby="react-tabs-310"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token number">1682408572790</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408572791</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"os"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"a description"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"version"</span>: <span class="token string">"1.0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"os"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"typeName"</span>: <span class="token string">"OS"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vendor"</span>: <span class="token string">"Vendor Limited, California"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"encrypted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"locked"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deleted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremodules/6">https://management-api.host.com/rest/v1/softwaremodules/6</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"artifacts"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremodules/6/artifacts">https://management-api.host.com/rest/v1/softwaremodules/6/artifacts</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremoduletypes/13">https://management-api.host.com/rest/v1/softwaremoduletypes/13</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremodules/6/metadata?offset=0&limit=50">https://management-api.host.com/rest/v1/softwaremodules/6/metadata?offset=0&limit=50</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token number">6</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-313" aria-labelledby="react-tabs-312"></div></div></div></div></div></div><div id="tag/Software-Modules/operation/updateSoftwareModule" data-section-id="tag/Software-Modules/operation/updateSoftwareModule" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/updateSoftwareModule" id="operation/updateSoftwareModule" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Software-Modules/operation/updateSoftwareModule" aria-label="tag/Software-Modules/operation/updateSoftwareModule"></a>Update Software Module<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the PUT request for a single softwaremodule within Hawkbit. Required Permission: UPDATE_REPOSITORY</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the PUT request for a single softwaremodule within Hawkbit. Required Permission: UPDATE_REPOSITORY</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="softwareModuleId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">softwareModuleId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><h5 class="sc-irLvIq cnGhhy">Request Body schema: <div class="sc-jIBlqr sc-hhyKGa bjIddV lkwvLJ"><svg class="sc-ilxebA bCxWCn" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div><div class="sc-gUjWJS sc-eKzvBH sc-jnlcPO itHPsH ciWJhv gcZOqF">required</div></h5><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"></div><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="description" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">description</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class=""><td kind="field" title="vendor" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">vendor</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class="last "><td kind="field" title="locked" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">locked</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">boolean</span></div> <div><div html="<p>Should be set only if change of locked state is requested. If put, the software module locked flag will be
|
||
set to the requested. Note: unlock (i.e. set this property to false) with extreme care!
|
||
In general once software module is locked it shall not be unlocked. Note that it could have been assigned /
|
||
deployed to targets.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Should be set only if change of locked state is requested. If put, the software module locked flag will be
|
||
set to the requested. Note: unlock (i.e. set this property to false) with extreme care!
|
||
In general once software module is locked it shall not be unlocked. Note that it could have been assigned /
|
||
deployed to targets.</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Software Module not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Software Module not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">409<!-- --> </strong><div html="<p>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.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>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.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">415<!-- --> </strong><div html="<p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="put" class="sc-jYnQyy hyHSPQ http-verb put">put</span><span class="sc-fYrVWQ gllLir">/rest/v1/softwaremodules/{softwareModuleId}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/softwaremodules/{softwareModuleId}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Request samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-314" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-315" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-315" aria-labelledby="react-tabs-314"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"SM Description"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vendor"</span>: <span class="token string">"SM Vendor Name"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"locked"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-316" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-317" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-318" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-319" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-317" aria-labelledby="react-tabs-316"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token number">1682408572790</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408572791</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"os"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"a description"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"version"</span>: <span class="token string">"1.0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"os"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"typeName"</span>: <span class="token string">"OS"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vendor"</span>: <span class="token string">"Vendor Limited, California"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"encrypted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"locked"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deleted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremodules/6">https://management-api.host.com/rest/v1/softwaremodules/6</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"artifacts"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremodules/6/artifacts">https://management-api.host.com/rest/v1/softwaremodules/6/artifacts</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremoduletypes/13">https://management-api.host.com/rest/v1/softwaremoduletypes/13</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremodules/6/metadata?offset=0&limit=50">https://management-api.host.com/rest/v1/softwaremodules/6/metadata?offset=0&limit=50</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token number">6</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-319" aria-labelledby="react-tabs-318"></div></div></div></div></div></div><div id="tag/Software-Modules/operation/deleteSoftwareModule" data-section-id="tag/Software-Modules/operation/deleteSoftwareModule" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/deleteSoftwareModule" id="operation/deleteSoftwareModule" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Software-Modules/operation/deleteSoftwareModule" aria-label="tag/Software-Modules/operation/deleteSoftwareModule"></a>Delete Software Module by Id<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the DELETE request for a single softwaremodule within Hawkbit. Required Permission: DELETE_REPOSITORY</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the DELETE request for a single softwaremodule within Hawkbit. Required Permission: DELETE_REPOSITORY</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="softwareModuleId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">softwareModuleId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA iSOCsR" disabled=""><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Software Module not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Software Module not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="delete" class="sc-jYnQyy jUYA-DF http-verb delete">delete</span><span class="sc-fYrVWQ gllLir">/rest/v1/softwaremodules/{softwareModuleId}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/softwaremodules/{softwareModuleId}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-320" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-321" tabindex="0" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-321" aria-labelledby="react-tabs-320"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-dQmiwx jCmKdj">application/json</div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"exceptionClass"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errorCode"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"info"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Software-Modules/operation/getMetadataValue_1" data-section-id="tag/Software-Modules/operation/getMetadataValue_1" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getMetadataValue_1" id="operation/getMetadataValue_1" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Software-Modules/operation/getMetadataValue_1" aria-label="tag/Software-Modules/operation/getMetadataValue_1"></a>Return single metadata value for a specific key of a Software Module<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Get a single metadata value for a metadata key. Required Permission: READ_REPOSITORY</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Get a single metadata value for a metadata key. Required Permission: READ_REPOSITORY</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="softwareModuleId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">softwareModuleId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class="last "><td kind="field" title="metadataKey" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">metadataKey</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Software Module not found </p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Software Module not found </p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/softwaremodules/{softwareModuleId}/metadata/{metadataKey}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/softwaremodules/{softwareModuleId}/metadata/{metadataKey}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-322" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-323" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-324" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-325" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-323" aria-labelledby="react-tabs-322"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"key"</span>: <span class="token string">"someKnownKey"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">"someKnownValue"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"targetVisible"</span>: <span class="token boolean">false</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-325" aria-labelledby="react-tabs-324"></div></div></div></div></div></div><div id="tag/Software-Modules/operation/updateMetadata_1" data-section-id="tag/Software-Modules/operation/updateMetadata_1" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/updateMetadata_1" id="operation/updateMetadata_1" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Software-Modules/operation/updateMetadata_1" aria-label="tag/Software-Modules/operation/updateMetadata_1"></a>Update a single metadata value of a Software Module<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Update a single metadata value for speficic key. Required Permission: UPDATE_REPOSITORY</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Update a single metadata value for speficic key. Required Permission: UPDATE_REPOSITORY</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="softwareModuleId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">softwareModuleId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class="last "><td kind="field" title="metadataKey" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">metadataKey</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><h5 class="sc-irLvIq cnGhhy">Request Body schema: <span class="sc-gYrqIg hJSqDi">application/json</span><div class="sc-gUjWJS sc-eKzvBH sc-jnlcPO itHPsH ciWJhv gcZOqF">required</div></h5><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"></div><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="value" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">value</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class="last "><td kind="field" title="targetVisible" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">targetVisible</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">boolean</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Software Module not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Software Module not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="put" class="sc-jYnQyy hyHSPQ http-verb put">put</span><span class="sc-fYrVWQ gllLir">/rest/v1/softwaremodules/{softwareModuleId}/metadata/{metadataKey}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/softwaremodules/{softwareModuleId}/metadata/{metadataKey}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Request samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-326" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-327" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-327" aria-labelledby="react-tabs-326"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-dQmiwx jCmKdj">application/json</div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">"newValue"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"targetVisible"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-328" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-329" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-330" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-331" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-329" aria-labelledby="react-tabs-328"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"key"</span>: <span class="token string">"someKnownKey"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">"someKnownValue"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"targetVisible"</span>: <span class="token boolean">false</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-331" aria-labelledby="react-tabs-330"></div></div></div></div></div></div><div id="tag/Software-Modules/operation/deleteMetadata_1" data-section-id="tag/Software-Modules/operation/deleteMetadata_1" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/deleteMetadata_1" id="operation/deleteMetadata_1" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Software-Modules/operation/deleteMetadata_1" aria-label="tag/Software-Modules/operation/deleteMetadata_1"></a>Delete single metadata entry from the software module<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Delete a single metadata. Required Permission: UPDATE_REPOSITORY</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Delete a single metadata. Required Permission: UPDATE_REPOSITORY</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="softwareModuleId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">softwareModuleId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class="last "><td kind="field" title="metadataKey" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">metadataKey</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA iSOCsR" disabled=""><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Software Module not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Software Module not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="delete" class="sc-jYnQyy jUYA-DF http-verb delete">delete</span><span class="sc-fYrVWQ gllLir">/rest/v1/softwaremodules/{softwareModuleId}/metadata/{metadataKey}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/softwaremodules/{softwareModuleId}/metadata/{metadataKey}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-332" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-333" tabindex="0" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-333" aria-labelledby="react-tabs-332"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-dQmiwx jCmKdj">application/json</div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"exceptionClass"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errorCode"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"info"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Software-Modules/operation/getSoftwareModules" data-section-id="tag/Software-Modules/operation/getSoftwareModules" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getSoftwareModules" id="operation/getSoftwareModules" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Software-Modules/operation/getSoftwareModules" aria-label="tag/Software-Modules/operation/getSoftwareModules"></a>Return all Software modules<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the GET request of retrieving all softwaremodules. Required Permission: READ_REPOSITORY</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the GET request of retrieving all softwaremodules. Required Permission: READ_REPOSITORY</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">query<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="offset" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">offset</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Default:<!-- --> </span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">0</span></div> <div><div html="<p>The paging offset (default is 0)</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The paging offset (default is 0)</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="limit" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">limit</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Default:<!-- --> </span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">50</span></div> <div><div html="<p>The maximum number of entries in a page (default is 50)</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The maximum number of entries in a page (default is 50)</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="sort" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">sort</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The query parameter sort allows to define the sort order for the result of a query. A sort criteria
|
||
consists of the name of a field and the sort direction (ASC for ascending and DESC descending).
|
||
The sequence of the sort criteria (multiple can be used) defines the sort order of the entities
|
||
in the result.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The query parameter sort allows to define the sort order for the result of a query. A sort criteria
|
||
consists of the name of a field and the sort direction (ASC for ascending and DESC descending).
|
||
The sequence of the sort criteria (multiple can be used) defines the sort order of the entities
|
||
in the result.</p>
|
||
</div></div></div></td></tr><tr class="last "><td kind="field" title="q" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">q</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for
|
||
available fields.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for
|
||
available fields.</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/softwaremodules</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/softwaremodules</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-334" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-335" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-336" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-337" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-335" aria-labelledby="react-tabs-334"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"content"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token number">1682408572790</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408572791</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"os"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"a description"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"version"</span>: <span class="token string">"1.0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"os"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"typeName"</span>: <span class="token string">"OS"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"vendor"</span>: <span class="token string">"Vendor Limited, California"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"encrypted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"locked"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deleted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremodules/6">https://management-api.host.com/rest/v1/softwaremodules/6</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"artifacts"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremodules/6/artifacts">https://management-api.host.com/rest/v1/softwaremodules/6/artifacts</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremoduletypes/13">https://management-api.host.com/rest/v1/softwaremoduletypes/13</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremodules/6/metadata?offset=0&limit=50">https://management-api.host.com/rest/v1/softwaremodules/6/metadata?offset=0&limit=50</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">6</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"total"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"size"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hreflang"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deprecation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"profile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"templated"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hreflang"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deprecation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"profile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"templated"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-337" aria-labelledby="react-tabs-336"></div></div></div></div></div></div><div id="tag/Software-Modules/operation/createSoftwareModules" data-section-id="tag/Software-Modules/operation/createSoftwareModules" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/createSoftwareModules" id="operation/createSoftwareModules" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Software-Modules/operation/createSoftwareModules" aria-label="tag/Software-Modules/operation/createSoftwareModules"></a>Create Software Module(s)<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the POST request of creating new software modules. The request body must always be a list of modules. Required Permission: CREATE_REPOSITORY</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the POST request of creating new software modules. The request body must always be a list of modules. Required Permission: CREATE_REPOSITORY</p>
|
||
</div></div><h5 class="sc-irLvIq cnGhhy">Request Body schema: <div class="sc-jIBlqr sc-hhyKGa bjIddV lkwvLJ"><svg class="sc-ilxebA bCxWCn" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div><div class="sc-gUjWJS sc-eKzvBH sc-jnlcPO itHPsH ciWJhv gcZOqF">required</div></h5><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"></div><div><div class="sc-bBkKde cplVKI"> Array </div><div class="sc-bbxCgr iZgtJR"><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="name" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">name</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class=""><td kind="field" title="version" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">version</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class=""><td kind="field" title="type" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">type</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class=""><td kind="field" title="description" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">description</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class=""><td kind="field" title="vendor" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">vendor</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class="last "><td kind="field" title="encrypted" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">encrypted</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">boolean</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div class="sc-iuOOrT hPMvVd"></div></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">201<!-- --> </strong><div html="<p>Successfully created</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully created</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">415<!-- --> </strong><div html="<p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="post" class="sc-jYnQyy jBKVIL http-verb post">post</span><span class="sc-fYrVWQ gllLir">/rest/v1/softwaremodules</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/softwaremodules</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Request samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-338" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-339" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-339" aria-labelledby="react-tabs-338"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"SM Name"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"version"</span>: <span class="token string">"1.0.0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"os"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"SM Description"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"vendor"</span>: <span class="token string">"Vendor Limited, California"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"encrypted"</span>: <span class="token boolean">false</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-340" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-341" tabindex="0" data-rttab="true">201</li><li class="tab-error" role="tab" id="react-tabs-342" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-343" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-341" aria-labelledby="react-tabs-340"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token number">1682408572790</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408572791</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"os"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"a description"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"version"</span>: <span class="token string">"1.0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"os"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"typeName"</span>: <span class="token string">"OS"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"vendor"</span>: <span class="token string">"Vendor Limited, California"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"encrypted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"locked"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deleted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremodules/6">https://management-api.host.com/rest/v1/softwaremodules/6</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"artifacts"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremodules/6/artifacts">https://management-api.host.com/rest/v1/softwaremodules/6/artifacts</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremoduletypes/13">https://management-api.host.com/rest/v1/softwaremoduletypes/13</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremodules/6/metadata?offset=0&limit=50">https://management-api.host.com/rest/v1/softwaremodules/6/metadata?offset=0&limit=50</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">6</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-343" aria-labelledby="react-tabs-342"></div></div></div></div></div></div><div id="tag/Software-Modules/operation/getMetadata_1" data-section-id="tag/Software-Modules/operation/getMetadata_1" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getMetadata_1" id="operation/getMetadata_1" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Software-Modules/operation/getMetadata_1" aria-label="tag/Software-Modules/operation/getMetadata_1"></a>Return metadata for a Software Module<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Get a paged list of metadata for a software module. Required Permission: READ_REPOSITORY</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Get a paged list of metadata for a software module. Required Permission: READ_REPOSITORY</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="softwareModuleId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">softwareModuleId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h5 class="sc-irLvIq cnGhhy">query<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="offset" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">offset</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Default:<!-- --> </span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">0</span></div> <div><div html="<p>The paging offset (default is 0)</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The paging offset (default is 0)</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="limit" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">limit</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Default:<!-- --> </span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">50</span></div> <div><div html="<p>The maximum number of entries in a page (default is 50)</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The maximum number of entries in a page (default is 50)</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="sort" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">sort</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The query parameter sort allows to define the sort order for the result of a query. A sort criteria
|
||
consists of the name of a field and the sort direction (ASC for ascending and DESC descending).
|
||
The sequence of the sort criteria (multiple can be used) defines the sort order of the entities
|
||
in the result.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The query parameter sort allows to define the sort order for the result of a query. A sort criteria
|
||
consists of the name of a field and the sort direction (ASC for ascending and DESC descending).
|
||
The sequence of the sort criteria (multiple can be used) defines the sort order of the entities
|
||
in the result.</p>
|
||
</div></div></div></td></tr><tr class="last "><td kind="field" title="q" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">q</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for
|
||
available fields.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for
|
||
available fields.</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Software Module not found </p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Software Module not found </p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/softwaremodules/{softwareModuleId}/metadata</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/softwaremodules/{softwareModuleId}/metadata</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-344" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-345" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-346" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-347" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-345" aria-labelledby="react-tabs-344"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"content"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"key"</span>: <span class="token string">"someKnownKey"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"value"</span>: <span class="token string">"someKnownValue"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"targetVisible"</span>: <span class="token boolean">false</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"total"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"size"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hreflang"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deprecation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"profile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"templated"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hreflang"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deprecation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"profile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"templated"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-347" aria-labelledby="react-tabs-346"></div></div></div></div></div></div><div id="tag/Software-Modules/operation/createMetadata_1" data-section-id="tag/Software-Modules/operation/createMetadata_1" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/createMetadata_1" id="operation/createMetadata_1" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Software-Modules/operation/createMetadata_1" aria-label="tag/Software-Modules/operation/createMetadata_1"></a>Creates a list of metadata for a specific Software Module<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Create a list of metadata entries Required Permission: UPDATE_REPOSITORY</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Create a list of metadata entries Required Permission: UPDATE_REPOSITORY</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="softwareModuleId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">softwareModuleId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><h5 class="sc-irLvIq cnGhhy">Request Body schema: <div class="sc-jIBlqr sc-hhyKGa bjIddV lkwvLJ"><svg class="sc-ilxebA bCxWCn" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/json" selected="">application/json</option><option value="application/hal+json">application/hal+json</option></select><label>application/json</label></div><div class="sc-gUjWJS sc-eKzvBH sc-jnlcPO itHPsH ciWJhv gcZOqF">required</div></h5><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"></div><div><div class="sc-bBkKde cplVKI"> Array </div><div class="sc-bbxCgr iZgtJR"><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="key" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">key</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>Metadata property key</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Metadata property key</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="value" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">value</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>Metadata property value</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Metadata property value</p>
|
||
</div></div></div></td></tr><tr class="last "><td kind="field" title="targetVisible" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">targetVisible</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">boolean</span></div> <div><div html="<p>Metadata property is visible to targets as part of software update action</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Metadata property is visible to targets as part of software update action</p>
|
||
</div></div></div></td></tr></tbody></table></div><div class="sc-iuOOrT hPMvVd"></div></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">201<!-- --> </strong><div html="<p>Successfully created</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully created</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Software Module not found</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Software Module not found</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">409<!-- --> </strong><div html="<p>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.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>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.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">415<!-- --> </strong><div html="<p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="post" class="sc-jYnQyy jBKVIL http-verb post">post</span><span class="sc-fYrVWQ gllLir">/rest/v1/softwaremodules/{softwareModuleId}/metadata</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/softwaremodules/{softwareModuleId}/metadata</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Request samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-348" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-349" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-349" aria-labelledby="react-tabs-348"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/json" selected="">application/json</option><option value="application/hal+json">application/hal+json</option></select><label>application/json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"key"</span>: <span class="token string">"someKnownKey"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"value"</span>: <span class="token string">"someKnownValue"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"targetVisible"</span>: <span class="token boolean">false</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-350" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-351" tabindex="0" data-rttab="true">201</li><li class="tab-error" role="tab" id="react-tabs-352" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-353" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-351" aria-labelledby="react-tabs-350"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"key"</span>: <span class="token string">"someKnownKey"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"value"</span>: <span class="token string">"someKnownValue"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"targetVisible"</span>: <span class="token boolean">false</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-353" aria-labelledby="react-tabs-352"></div></div></div></div></div></div><div id="tag/Software-Modules/operation/getArtifacts" data-section-id="tag/Software-Modules/operation/getArtifacts" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getArtifacts" id="operation/getArtifacts" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Software-Modules/operation/getArtifacts" aria-label="tag/Software-Modules/operation/getArtifacts"></a>Return all metadata of artifacts assigned to a software module<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the GET request of retrieving all metadata of artifacts assigned to a software module. Required Permission: READ_REPOSITORY</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the GET request of retrieving all metadata of artifacts assigned to a software module. Required Permission: READ_REPOSITORY</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="softwareModuleId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">softwareModuleId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h5 class="sc-irLvIq cnGhhy">query<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="representation" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">representation</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Default:<!-- --> </span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">"compact"</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class="last "><td kind="field" title="useartifacturlhandler" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">useartifacturlhandler</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">boolean</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Software Module not found </p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Software Module not found </p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/softwaremodules/{softwareModuleId}/artifacts</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/softwaremodules/{softwareModuleId}/artifacts</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-354" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-355" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-356" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-357" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-355" aria-labelledby="react-tabs-354"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token number">1682408572660</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408572660</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hashes"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"sha1"</span>: <span class="token string">"70686514bec4a9f8188f88d470fb3d7999728fad"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"md5"</span>: <span class="token string">"f7c5b155e3636406cbc53c61f4692637"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"sha256"</span>: <span class="token string">"efbbd71e3aa3c1db9ff3905c81f1220adb0e5db3c5438732eedf98ab006ca742"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"providedFilename"</span>: <span class="token string">"origFilename"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"size"</span>: <span class="token number">11</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremodules/1/artifacts/1">https://management-api.host.com/rest/v1/softwaremodules/1/artifacts/1</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"download"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremodules/1/artifacts/1/download">https://management-api.host.com/rest/v1/softwaremodules/1/artifacts/1/download</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-357" aria-labelledby="react-tabs-356"></div></div></div></div></div></div><div id="tag/Software-Modules/operation/uploadArtifact" data-section-id="tag/Software-Modules/operation/uploadArtifact" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/uploadArtifact" id="operation/uploadArtifact" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Software-Modules/operation/uploadArtifact" aria-label="tag/Software-Modules/operation/uploadArtifact"></a>Upload artifact<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles POST request for artifact upload. Required Permission: CREATE_REPOSITORY</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles POST request for artifact upload. Required Permission: CREATE_REPOSITORY</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="softwareModuleId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">softwareModuleId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h5 class="sc-irLvIq cnGhhy">query<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="filename" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">filename</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class=""><td kind="field" title="md5sum" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">md5sum</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class=""><td kind="field" title="sha1sum" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">sha1sum</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class="last "><td kind="field" title="sha256sum" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">sha256sum</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><h5 class="sc-irLvIq cnGhhy">Request Body schema: <span class="sc-gYrqIg hJSqDi">multipart/form-data</span></h5><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"></div><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="file" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">file</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->binary<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">201<!-- --> </strong><div html="<p>Successfully created</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully created</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Software Module not found</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Software Module not found</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">415<!-- --> </strong><div html="<p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="post" class="sc-jYnQyy jBKVIL http-verb post">post</span><span class="sc-fYrVWQ gllLir">/rest/v1/softwaremodules/{softwareModuleId}/artifacts</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/softwaremodules/{softwareModuleId}/artifacts</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-358" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-359" tabindex="0" data-rttab="true">201</li><li class="tab-error" role="tab" id="react-tabs-360" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-361" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-359" aria-labelledby="react-tabs-358"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token number">1682408572660</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408572660</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"hashes"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"sha1"</span>: <span class="token string">"70686514bec4a9f8188f88d470fb3d7999728fad"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"md5"</span>: <span class="token string">"f7c5b155e3636406cbc53c61f4692637"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"sha256"</span>: <span class="token string">"efbbd71e3aa3c1db9ff3905c81f1220adb0e5db3c5438732eedf98ab006ca742"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"providedFilename"</span>: <span class="token string">"origFilename"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"size"</span>: <span class="token number">11</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremodules/1/artifacts/1">https://management-api.host.com/rest/v1/softwaremodules/1/artifacts/1</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"download"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremodules/1/artifacts/1/download">https://management-api.host.com/rest/v1/softwaremodules/1/artifacts/1/download</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-361" aria-labelledby="react-tabs-360"></div></div></div></div></div></div><div id="tag/Software-Modules/operation/getArtifact" data-section-id="tag/Software-Modules/operation/getArtifact" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getArtifact" id="operation/getArtifact" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Software-Modules/operation/getArtifact" aria-label="tag/Software-Modules/operation/getArtifact"></a>Return single Artifact metadata<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the GET request of retrieving a single Artifact metadata request. Required Permission: READ_REPOSITORY</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the GET request of retrieving a single Artifact metadata request. Required Permission: READ_REPOSITORY</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="softwareModuleId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">softwareModuleId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class="last "><td kind="field" title="artifactId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">artifactId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h5 class="sc-irLvIq cnGhhy">query<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="useartifacturlhandler" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">useartifacturlhandler</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">boolean</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Software Module not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Software Module not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/softwaremodules/{softwareModuleId}/artifacts/{artifactId}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/softwaremodules/{softwareModuleId}/artifacts/{artifactId}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-362" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-363" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-364" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-365" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-363" aria-labelledby="react-tabs-362"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token number">1682408572660</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408572660</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"hashes"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"sha1"</span>: <span class="token string">"70686514bec4a9f8188f88d470fb3d7999728fad"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"md5"</span>: <span class="token string">"f7c5b155e3636406cbc53c61f4692637"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"sha256"</span>: <span class="token string">"efbbd71e3aa3c1db9ff3905c81f1220adb0e5db3c5438732eedf98ab006ca742"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"providedFilename"</span>: <span class="token string">"origFilename"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"size"</span>: <span class="token number">11</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremodules/1/artifacts/1">https://management-api.host.com/rest/v1/softwaremodules/1/artifacts/1</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"download"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremodules/1/artifacts/1/download">https://management-api.host.com/rest/v1/softwaremodules/1/artifacts/1/download</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-365" aria-labelledby="react-tabs-364"></div></div></div></div></div></div><div id="tag/Software-Modules/operation/deleteArtifact" data-section-id="tag/Software-Modules/operation/deleteArtifact" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/deleteArtifact" id="operation/deleteArtifact" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Software-Modules/operation/deleteArtifact" aria-label="tag/Software-Modules/operation/deleteArtifact"></a>Delete artifact by Id<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the DELETE request for a single Artifact assigned to a SoftwareModule. Required Permission: DELETE_REPOSITORY</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the DELETE request for a single Artifact assigned to a SoftwareModule. Required Permission: DELETE_REPOSITORY</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="softwareModuleId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">softwareModuleId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class="last "><td kind="field" title="artifactId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">artifactId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA iSOCsR" disabled=""><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Software Module not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Software Module not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="delete" class="sc-jYnQyy jUYA-DF http-verb delete">delete</span><span class="sc-fYrVWQ gllLir">/rest/v1/softwaremodules/{softwareModuleId}/artifacts/{artifactId}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/softwaremodules/{softwareModuleId}/artifacts/{artifactId}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-366" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-367" tabindex="0" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-367" aria-labelledby="react-tabs-366"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-dQmiwx jCmKdj">application/json</div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"exceptionClass"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errorCode"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"info"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Target-Tags" data-section-id="tag/Target-Tags" class="sc-eDLKkx hNzKJC"><div class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h1 class="sc-fsYfdN gqLiaw"><a class="sc-csKJxZ fNhImz" href="#tag/Target-Tags" aria-label="tag/Target-Tags"></a>Target Tags</h1></div></div><div class="sc-hLQSwg jSgyLg"><div class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS redoc-markdown " html="<p>REST API for Target Tag CRUD operations.</p>
|
||
"><p>REST API for Target Tag CRUD operations.</p>
|
||
</div></div></div><div id="tag/Target-Tags/operation/getTargetTag" data-section-id="tag/Target-Tags/operation/getTargetTag" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getTargetTag" id="operation/getTargetTag" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Target-Tags/operation/getTargetTag" aria-label="tag/Target-Tags/operation/getTargetTag"></a>Return target tag by id<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the GET request of retrieving a single target tag.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the GET request of retrieving a single target tag.</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="targetTagId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">targetTagId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Target tag not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Target tag not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/targettags/{targetTagId}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/targettags/{targetTagId}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-368" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-369" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-370" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-371" data-rttab="true">400</li><li class="tab-error" role="tab" id="react-tabs-372" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-373" data-rttab="true">401</li><li class="tab-error" role="tab" id="react-tabs-374" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-375" data-rttab="true">403</li><li class="tab-error" role="tab" id="react-tabs-376" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-377" data-rttab="true">405</li><li class="tab-error" role="tab" id="react-tabs-378" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-379" data-rttab="true">406</li><li class="tab-error" role="tab" id="react-tabs-380" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-381" data-rttab="true">429</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-369" aria-labelledby="react-tabs-368"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token number">1682408561990</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408561992</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"DsTag"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"My name is DsTag"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"colour"</span>: <span class="token string">"default"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsettags/6">https://management-api.host.com/rest/v1/distributionsettags/6</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"assignedDistributionSets"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsettags/6/assigned?offset=0&limit=50">https://management-api.host.com/rest/v1/distributionsettags/6/assigned?offset=0&limit=50</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token number">6</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-371" aria-labelledby="react-tabs-370"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-373" aria-labelledby="react-tabs-372"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-375" aria-labelledby="react-tabs-374"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-377" aria-labelledby="react-tabs-376"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-379" aria-labelledby="react-tabs-378"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-381" aria-labelledby="react-tabs-380"></div></div></div></div></div></div><div id="tag/Target-Tags/operation/updateTargetTag" data-section-id="tag/Target-Tags/operation/updateTargetTag" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/updateTargetTag" id="operation/updateTargetTag" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Target-Tags/operation/updateTargetTag" aria-label="tag/Target-Tags/operation/updateTargetTag"></a>Update target tag by id<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the PUT request of updating a target tag.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the PUT request of updating a target tag.</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="targetTagId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">targetTagId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><h5 class="sc-irLvIq cnGhhy">Request Body schema: <div class="sc-jIBlqr sc-hhyKGa bjIddV lkwvLJ"><svg class="sc-ilxebA bCxWCn" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div><div class="sc-gUjWJS sc-eKzvBH sc-jnlcPO itHPsH ciWJhv gcZOqF">required</div></h5><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"></div><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="name" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">name</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The name of the entity</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The name of the entity</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="description" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">description</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The description of the entity</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The description of the entity</p>
|
||
</div></div></div></td></tr><tr class="last "><td kind="field" title="colour" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">colour</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The colour of the entity</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The colour of the entity</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Target tag not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Target tag not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">409<!-- --> </strong><div html="<p>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.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>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.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">415<!-- --> </strong><div html="<p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="put" class="sc-jYnQyy hyHSPQ http-verb put">put</span><span class="sc-fYrVWQ gllLir">/rest/v1/targettags/{targetTagId}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/targettags/{targetTagId}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Request samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-382" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-383" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-383" aria-labelledby="react-tabs-382"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"Example name"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"Example description"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"colour"</span>: <span class="token string">"rgb(0,255,0)"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-384" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-385" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-386" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-387" data-rttab="true">400</li><li class="tab-error" role="tab" id="react-tabs-388" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-389" data-rttab="true">401</li><li class="tab-error" role="tab" id="react-tabs-390" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-391" data-rttab="true">403</li><li class="tab-error" role="tab" id="react-tabs-392" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-393" data-rttab="true">405</li><li class="tab-error" role="tab" id="react-tabs-394" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-395" data-rttab="true">406</li><li class="tab-error" role="tab" id="react-tabs-396" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-397" data-rttab="true">409</li><li class="tab-error" role="tab" id="react-tabs-398" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-399" data-rttab="true">415</li><li class="tab-error" role="tab" id="react-tabs-400" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-401" data-rttab="true">429</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-385" aria-labelledby="react-tabs-384"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token number">1682408561990</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408561992</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"DsTag"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"My name is DsTag"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"colour"</span>: <span class="token string">"default"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsettags/6">https://management-api.host.com/rest/v1/distributionsettags/6</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"assignedDistributionSets"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsettags/6/assigned?offset=0&limit=50">https://management-api.host.com/rest/v1/distributionsettags/6/assigned?offset=0&limit=50</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token number">6</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-387" aria-labelledby="react-tabs-386"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-389" aria-labelledby="react-tabs-388"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-391" aria-labelledby="react-tabs-390"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-393" aria-labelledby="react-tabs-392"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-395" aria-labelledby="react-tabs-394"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-397" aria-labelledby="react-tabs-396"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-399" aria-labelledby="react-tabs-398"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-401" aria-labelledby="react-tabs-400"></div></div></div></div></div></div><div id="tag/Target-Tags/operation/deleteTargetTag" data-section-id="tag/Target-Tags/operation/deleteTargetTag" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/deleteTargetTag" id="operation/deleteTargetTag" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Target-Tags/operation/deleteTargetTag" aria-label="tag/Target-Tags/operation/deleteTargetTag"></a>Delete target tag by id<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the DELETE request of deleting a single target tag.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the DELETE request of deleting a single target tag.</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="targetTagId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">targetTagId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA iSOCsR" disabled=""><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Target tag not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Target tag not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="delete" class="sc-jYnQyy jUYA-DF http-verb delete">delete</span><span class="sc-fYrVWQ gllLir">/rest/v1/targettags/{targetTagId}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/targettags/{targetTagId}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-402" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-403" tabindex="0" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-403" aria-labelledby="react-tabs-402"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-dQmiwx jCmKdj">application/json</div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"exceptionClass"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errorCode"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"info"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Target-Tags/operation/getAssignedTargets" data-section-id="tag/Target-Tags/operation/getAssignedTargets" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getAssignedTargets" id="operation/getAssignedTargets" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Target-Tags/operation/getAssignedTargets" aria-label="tag/Target-Tags/operation/getAssignedTargets"></a>Return assigned targets for tag<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the GET request of retrieving a list of assigned targets.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the GET request of retrieving a list of assigned targets.</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="targetTagId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">targetTagId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h5 class="sc-irLvIq cnGhhy">query<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="offset" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">offset</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Default:<!-- --> </span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">0</span></div> <div><div html="<p>The paging offset (default is 0)</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The paging offset (default is 0)</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="limit" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">limit</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Default:<!-- --> </span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">50</span></div> <div><div html="<p>The maximum number of entries in a page (default is 50)</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The maximum number of entries in a page (default is 50)</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="sort" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">sort</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The query parameter sort allows to define the sort order for the result of a query. A sort criteria
|
||
consists of the name of a field and the sort direction (ASC for ascending and DESC descending).
|
||
The sequence of the sort criteria (multiple can be used) defines the sort order of the entities
|
||
in the result.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The query parameter sort allows to define the sort order for the result of a query. A sort criteria
|
||
consists of the name of a field and the sort direction (ASC for ascending and DESC descending).
|
||
The sequence of the sort criteria (multiple can be used) defines the sort order of the entities
|
||
in the result.</p>
|
||
</div></div></div></td></tr><tr class="last "><td kind="field" title="q" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">q</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for
|
||
available fields.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for
|
||
available fields.</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Target tag not found</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Target tag not found</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/targettags/{targetTagId}/assigned</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/targettags/{targetTagId}/assigned</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-404" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-405" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-406" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-407" data-rttab="true">400</li><li class="tab-error" role="tab" id="react-tabs-408" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-409" data-rttab="true">401</li><li class="tab-error" role="tab" id="react-tabs-410" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-411" data-rttab="true">403</li><li class="tab-error" role="tab" id="react-tabs-412" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-413" data-rttab="true">405</li><li class="tab-error" role="tab" id="react-tabs-414" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-415" data-rttab="true">406</li><li class="tab-error" role="tab" id="react-tabs-416" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-417" data-rttab="true">429</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-405" aria-labelledby="react-tabs-404"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"content"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token number">1682408577979</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408577988</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"137"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"My name is 137"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"controllerId"</span>: <span class="token string">"137"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"updateStatus"</span>: <span class="token string">"in_sync"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastControllerRequestAt"</span>: <span class="token number">1682408577978</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"installedAt"</span>: <span class="token number">1682408577987</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ipAddress"</span>: <span class="token string">"192.168.0.1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"address"</span>: <span class="token string">"</span><a href="http://192.168.0.1">http://192.168.0.1</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"pollStatus"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"lastRequestAt"</span>: <span class="token number">1682408577978</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"nextExpectedRequestAt"</span>: <span class="token number">1682451777978</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"overdue"</span>: <span class="token boolean">false</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"securityToken"</span>: <span class="token string">"949f1c3487125467464a960d750373c1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"requestAttributes"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"targetType"</span>: <span class="token number">13</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"targetTypeName"</span>: <span class="token string">"defaultType"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"autoConfirmActive"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/137">https://management-api.host.com/rest/v1/targets/137</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"assignedDS"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/137/assignedDS">https://management-api.host.com/rest/v1/targets/137/assignedDS</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"installedDS"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/137/installedDS">https://management-api.host.com/rest/v1/targets/137/installedDS</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"attributes"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/137/attributes">https://management-api.host.com/rest/v1/targets/137/attributes</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"actions"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/137/actions?offset=0&limit=50&sort=id%253ADESC">https://management-api.host.com/rest/v1/targets/137/actions?offset=0&limit=50&sort=id%3ADESC</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/137/metadata?offset=0&limit=50">https://management-api.host.com/rest/v1/targets/137/metadata?offset=0&limit=50</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"targetType"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targettypes/13">https://management-api.host.com/rest/v1/targettypes/13</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"autoConfirm"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targets/137/autoConfirm">https://management-api.host.com/rest/v1/targets/137/autoConfirm</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"total"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"size"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hreflang"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deprecation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"profile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"templated"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hreflang"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deprecation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"profile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"templated"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-407" aria-labelledby="react-tabs-406"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-409" aria-labelledby="react-tabs-408"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-411" aria-labelledby="react-tabs-410"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-413" aria-labelledby="react-tabs-412"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-415" aria-labelledby="react-tabs-414"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-417" aria-labelledby="react-tabs-416"></div></div></div></div></div></div><div id="tag/Target-Tags/operation/assignTargets" data-section-id="tag/Target-Tags/operation/assignTargets" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/assignTargets" id="operation/assignTargets" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Target-Tags/operation/assignTargets" aria-label="tag/Target-Tags/operation/assignTargets"></a>Assign target(s) to given tagId<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the POST request of target assignment. Already assigned target will be ignored.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the POST request of target assignment. Already assigned target will be ignored.</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="targetTagId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">targetTagId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h5 class="sc-irLvIq cnGhhy">query<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="onNotFoundPolicy" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">onNotFoundPolicy</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Default:<!-- --> </span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">"FAIL"</span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Enum<!-- -->:</span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">"FAIL"</span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">"ON_WHAT_FOUND_AND_FAIL"</span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">"ON_WHAT_FOUND_AND_SUCCESS"</span> </div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><h5 class="sc-irLvIq cnGhhy">Request Body schema: <div class="sc-jIBlqr sc-hhyKGa bjIddV lkwvLJ"><svg class="sc-ilxebA bCxWCn" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div><div class="sc-gUjWJS sc-eKzvBH sc-jnlcPO itHPsH ciWJhv gcZOqF">required</div></h5><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"></div><div><div class="sc-bBkKde cplVKI"> Array </div><div class="sc-bbxCgr iZgtJR"><div><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>List of controller ids to be assigned</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>List of controller ids to be assigned</p>
|
||
</div></div></div></div></div><div class="sc-iuOOrT hPMvVd"></div></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA iSOCsR" disabled=""><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully assigned</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully assigned</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Not Found - e.g. target tag not found. Contains info about not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Not Found - e.g. target tag not found. Contains info about not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">409<!-- --> </strong><div html="<p>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.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>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.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">415<!-- --> </strong><div html="<p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="put" class="sc-jYnQyy hyHSPQ http-verb put">put</span><span class="sc-fYrVWQ gllLir">/rest/v1/targettags/{targetTagId}/assigned</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/targettags/{targetTagId}/assigned</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Request samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-418" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-419" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-419" aria-labelledby="react-tabs-418"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"controllerId1"</span>,</div></li><li><div class="hoverable "><span class="token string">"controllerId2"</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-420" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-421" tabindex="0" data-rttab="true">400</li><li class="tab-error" role="tab" id="react-tabs-422" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-423" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-421" aria-labelledby="react-tabs-420"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-dQmiwx jCmKdj">application/json</div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"exceptionClass"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errorCode"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"info"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-423" aria-labelledby="react-tabs-422"></div></div></div></div></div></div><div id="tag/Target-Tags/operation/unassignTargets" data-section-id="tag/Target-Tags/operation/unassignTargets" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/unassignTargets" id="operation/unassignTargets" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Target-Tags/operation/unassignTargets" aria-label="tag/Target-Tags/operation/unassignTargets"></a>Unassign targets from a given tagId<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the DELETE request to unassign the given targets.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the DELETE request to unassign the given targets.</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="targetTagId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">targetTagId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h5 class="sc-irLvIq cnGhhy">query<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="onNotFoundPolicy" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">onNotFoundPolicy</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Default:<!-- --> </span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">"FAIL"</span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Enum<!-- -->:</span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">"FAIL"</span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">"ON_WHAT_FOUND_AND_FAIL"</span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">"ON_WHAT_FOUND_AND_SUCCESS"</span> </div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><h5 class="sc-irLvIq cnGhhy">Request Body schema: <div class="sc-jIBlqr sc-hhyKGa bjIddV lkwvLJ"><svg class="sc-ilxebA bCxWCn" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div><div class="sc-gUjWJS sc-eKzvBH sc-jnlcPO itHPsH ciWJhv gcZOqF">required</div></h5><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"></div><div><div class="sc-bBkKde cplVKI"> Array </div><div class="sc-bbxCgr iZgtJR"><div><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>List of controller ids to be unassigned</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>List of controller ids to be unassigned</p>
|
||
</div></div></div></div></div><div class="sc-iuOOrT hPMvVd"></div></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA iSOCsR" disabled=""><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Not Found - e.g. target tag not found. Contains info about not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Not Found - e.g. target tag not found. Contains info about not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="delete" class="sc-jYnQyy jUYA-DF http-verb delete">delete</span><span class="sc-fYrVWQ gllLir">/rest/v1/targettags/{targetTagId}/assigned</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/targettags/{targetTagId}/assigned</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Request samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-424" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-425" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-425" aria-labelledby="react-tabs-424"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"controllerId1"</span>,</div></li><li><div class="hoverable "><span class="token string">"controllerId2"</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-426" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-427" tabindex="0" data-rttab="true">400</li><li class="tab-error" role="tab" id="react-tabs-428" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-429" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-427" aria-labelledby="react-tabs-426"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-dQmiwx jCmKdj">application/json</div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"exceptionClass"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errorCode"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"info"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-429" aria-labelledby="react-tabs-428"></div></div></div></div></div></div><div id="tag/Target-Tags/operation/getTargetTags" data-section-id="tag/Target-Tags/operation/getTargetTags" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getTargetTags" id="operation/getTargetTags" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Target-Tags/operation/getTargetTags" aria-label="tag/Target-Tags/operation/getTargetTags"></a>Return all target tags<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the GET request of retrieving all target tags.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the GET request of retrieving all target tags.</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">query<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="offset" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">offset</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Default:<!-- --> </span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">0</span></div> <div><div html="<p>The paging offset (default is 0)</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The paging offset (default is 0)</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="limit" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">limit</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Default:<!-- --> </span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">50</span></div> <div><div html="<p>The maximum number of entries in a page (default is 50)</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The maximum number of entries in a page (default is 50)</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="sort" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">sort</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The query parameter sort allows to define the sort order for the result of a query. A sort criteria
|
||
consists of the name of a field and the sort direction (ASC for ascending and DESC descending).
|
||
The sequence of the sort criteria (multiple can be used) defines the sort order of the entities
|
||
in the result.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The query parameter sort allows to define the sort order for the result of a query. A sort criteria
|
||
consists of the name of a field and the sort direction (ASC for ascending and DESC descending).
|
||
The sequence of the sort criteria (multiple can be used) defines the sort order of the entities
|
||
in the result.</p>
|
||
</div></div></div></td></tr><tr class="last "><td kind="field" title="q" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">q</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for
|
||
available fields.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for
|
||
available fields.</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/targettags</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/targettags</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-430" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-431" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-432" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-433" data-rttab="true">400</li><li class="tab-error" role="tab" id="react-tabs-434" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-435" data-rttab="true">401</li><li class="tab-error" role="tab" id="react-tabs-436" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-437" data-rttab="true">403</li><li class="tab-error" role="tab" id="react-tabs-438" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-439" data-rttab="true">405</li><li class="tab-error" role="tab" id="react-tabs-440" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-441" data-rttab="true">406</li><li class="tab-error" role="tab" id="react-tabs-442" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-443" data-rttab="true">429</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-431" aria-labelledby="react-tabs-430"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"content"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token number">1682408561990</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408561992</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"DsTag"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"My name is DsTag"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"colour"</span>: <span class="token string">"default"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsettags/6">https://management-api.host.com/rest/v1/distributionsettags/6</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"assignedDistributionSets"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsettags/6/assigned?offset=0&limit=50">https://management-api.host.com/rest/v1/distributionsettags/6/assigned?offset=0&limit=50</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">6</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"total"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"size"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hreflang"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deprecation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"profile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"templated"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hreflang"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deprecation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"profile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"templated"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-433" aria-labelledby="react-tabs-432"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-435" aria-labelledby="react-tabs-434"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-437" aria-labelledby="react-tabs-436"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-439" aria-labelledby="react-tabs-438"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-441" aria-labelledby="react-tabs-440"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-443" aria-labelledby="react-tabs-442"></div></div></div></div></div></div><div id="tag/Target-Tags/operation/createTargetTags" data-section-id="tag/Target-Tags/operation/createTargetTags" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/createTargetTags" id="operation/createTargetTags" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Target-Tags/operation/createTargetTags" aria-label="tag/Target-Tags/operation/createTargetTags"></a>Create target tag(s)<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the POST request of creating new target tag. The request body must always be a list of target tags.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the POST request of creating new target tag. The request body must always be a list of target tags.</p>
|
||
</div></div><h5 class="sc-irLvIq cnGhhy">Request Body schema: <div class="sc-jIBlqr sc-hhyKGa bjIddV lkwvLJ"><svg class="sc-ilxebA bCxWCn" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div><div class="sc-gUjWJS sc-eKzvBH sc-jnlcPO itHPsH ciWJhv gcZOqF">required</div></h5><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"></div><div><div class="sc-bBkKde cplVKI"> Array </div><div class="sc-bbxCgr iZgtJR"><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="name" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">name</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The name of the entity</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The name of the entity</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="description" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">description</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The description of the entity</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The description of the entity</p>
|
||
</div></div></div></td></tr><tr class="last "><td kind="field" title="colour" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">colour</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The colour of the entity</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The colour of the entity</p>
|
||
</div></div></div></td></tr></tbody></table></div><div class="sc-iuOOrT hPMvVd"></div></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">201<!-- --> </strong><div html="<p>Successfully created</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully created</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">409<!-- --> </strong><div html="<p>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.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>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.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">415<!-- --> </strong><div html="<p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="post" class="sc-jYnQyy jBKVIL http-verb post">post</span><span class="sc-fYrVWQ gllLir">/rest/v1/targettags</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/targettags</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Request samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-444" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-445" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-445" aria-labelledby="react-tabs-444"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"Example name"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"Example description"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"colour"</span>: <span class="token string">"rgb(0,255,0)"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-446" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-447" tabindex="0" data-rttab="true">201</li><li class="tab-error" role="tab" id="react-tabs-448" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-449" data-rttab="true">400</li><li class="tab-error" role="tab" id="react-tabs-450" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-451" data-rttab="true">401</li><li class="tab-error" role="tab" id="react-tabs-452" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-453" data-rttab="true">403</li><li class="tab-error" role="tab" id="react-tabs-454" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-455" data-rttab="true">405</li><li class="tab-error" role="tab" id="react-tabs-456" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-457" data-rttab="true">406</li><li class="tab-error" role="tab" id="react-tabs-458" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-459" data-rttab="true">409</li><li class="tab-error" role="tab" id="react-tabs-460" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-461" data-rttab="true">415</li><li class="tab-error" role="tab" id="react-tabs-462" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-463" data-rttab="true">429</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-447" aria-labelledby="react-tabs-446"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token number">1682408561990</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408561992</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"DsTag"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"My name is DsTag"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"colour"</span>: <span class="token string">"default"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsettags/6">https://management-api.host.com/rest/v1/distributionsettags/6</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"assignedDistributionSets"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsettags/6/assigned?offset=0&limit=50">https://management-api.host.com/rest/v1/distributionsettags/6/assigned?offset=0&limit=50</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">6</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-449" aria-labelledby="react-tabs-448"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-451" aria-labelledby="react-tabs-450"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-453" aria-labelledby="react-tabs-452"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-455" aria-labelledby="react-tabs-454"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-457" aria-labelledby="react-tabs-456"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-459" aria-labelledby="react-tabs-458"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-461" aria-labelledby="react-tabs-460"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-463" aria-labelledby="react-tabs-462"></div></div></div></div></div></div><div id="tag/Target-Tags/operation/assignTarget" data-section-id="tag/Target-Tags/operation/assignTarget" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/assignTarget" id="operation/assignTarget" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Target-Tags/operation/assignTarget" aria-label="tag/Target-Tags/operation/assignTarget"></a>Assign target(s) to given tagId<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the POST request of target assignment. Already assigned target will be ignored.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the POST request of target assignment. Already assigned target will be ignored.</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="targetTagId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">targetTagId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class="last "><td kind="field" title="controllerId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">controllerId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA iSOCsR" disabled=""><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully assigned</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully assigned</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">409<!-- --> </strong><div html="<p>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.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>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.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">415<!-- --> </strong><div html="<p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="post" class="sc-jYnQyy jBKVIL http-verb post">post</span><span class="sc-fYrVWQ gllLir">/rest/v1/targettags/{targetTagId}/assigned/{controllerId}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/targettags/{targetTagId}/assigned/{controllerId}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-464" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-465" tabindex="0" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-465" aria-labelledby="react-tabs-464"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-dQmiwx jCmKdj">application/json</div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"exceptionClass"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errorCode"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"info"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Target-Tags/operation/unassignTarget" data-section-id="tag/Target-Tags/operation/unassignTarget" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/unassignTarget" id="operation/unassignTarget" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Target-Tags/operation/unassignTarget" aria-label="tag/Target-Tags/operation/unassignTarget"></a>Unassign target from a given tagId<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the DELETE request to unassign the given target.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the DELETE request to unassign the given target.</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="targetTagId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">targetTagId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class="last "><td kind="field" title="controllerId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">controllerId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA iSOCsR" disabled=""><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Target not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Target not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="delete" class="sc-jYnQyy jUYA-DF http-verb delete">delete</span><span class="sc-fYrVWQ gllLir">/rest/v1/targettags/{targetTagId}/assigned/{controllerId}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/targettags/{targetTagId}/assigned/{controllerId}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-466" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-467" tabindex="0" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-467" aria-labelledby="react-tabs-466"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-dQmiwx jCmKdj">application/json</div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"exceptionClass"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errorCode"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"info"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Target-Filter-Queries" data-section-id="tag/Target-Filter-Queries" class="sc-eDLKkx hNzKJC"><div class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h1 class="sc-fsYfdN gqLiaw"><a class="sc-csKJxZ fNhImz" href="#tag/Target-Filter-Queries" aria-label="tag/Target-Filter-Queries"></a>Target Filter Queries</h1></div></div><div class="sc-hLQSwg jSgyLg"><div class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS redoc-markdown " html="<p>REST API for Target Filter Queries CRUD operations.</p>
|
||
"><p>REST API for Target Filter Queries CRUD operations.</p>
|
||
</div></div></div><div id="tag/Target-Filter-Queries/operation/getFilter" data-section-id="tag/Target-Filter-Queries/operation/getFilter" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getFilter" id="operation/getFilter" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Target-Filter-Queries/operation/getFilter" aria-label="tag/Target-Filter-Queries/operation/getFilter"></a>Return target filter query by id<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the GET request of retrieving a single target filter query. Required permission: READ_TARGET</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the GET request of retrieving a single target filter query. Required permission: READ_TARGET</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="filterId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">filterId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Target filter query not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Target filter query not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/targetfilters/{filterId}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/targetfilters/{filterId}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-468" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-469" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-470" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-471" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-469" aria-labelledby="react-tabs-468"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token number">1682408566380</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408566385</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"filter1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"query"</span>: <span class="token string">"name==*"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"autoAssignDistributionSet"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"autoAssignActionType"</span>: <span class="token string">"forced"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"autoAssignWeight"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"confirmationRequired"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targetfilters/5">https://management-api.host.com/rest/v1/targetfilters/5</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"autoAssignDS"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targetfilters/5/autoAssignDS">https://management-api.host.com/rest/v1/targetfilters/5/autoAssignDS</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token number">5</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-471" aria-labelledby="react-tabs-470"></div></div></div></div></div></div><div id="tag/Target-Filter-Queries/operation/updateFilter" data-section-id="tag/Target-Filter-Queries/operation/updateFilter" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/updateFilter" id="operation/updateFilter" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Target-Filter-Queries/operation/updateFilter" aria-label="tag/Target-Filter-Queries/operation/updateFilter"></a>Updates target filter query by id<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the PUT request of updating a target filter query. Required permission: UPDATE_TARGET</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the PUT request of updating a target filter query. Required permission: UPDATE_TARGET</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="filterId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">filterId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><h5 class="sc-irLvIq cnGhhy">Request Body schema: <div class="sc-jIBlqr sc-hhyKGa bjIddV lkwvLJ"><svg class="sc-ilxebA bCxWCn" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div><div class="sc-gUjWJS sc-eKzvBH sc-jnlcPO itHPsH ciWJhv gcZOqF">required</div></h5><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"></div><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="name" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">name</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class="last "><td kind="field" title="query" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">query</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Target filter query not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Target filter query not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">409<!-- --> </strong><div html="<p>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.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>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.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">415<!-- --> </strong><div html="<p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="put" class="sc-jYnQyy hyHSPQ http-verb put">put</span><span class="sc-fYrVWQ gllLir">/rest/v1/targetfilters/{filterId}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/targetfilters/{filterId}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Request samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-472" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-473" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-473" aria-labelledby="react-tabs-472"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"filterName"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"query"</span>: <span class="token string">"controllerId==example-target-*"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-474" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-475" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-476" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-477" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-475" aria-labelledby="react-tabs-474"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token number">1682408566380</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408566385</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"filter1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"query"</span>: <span class="token string">"name==*"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"autoAssignDistributionSet"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"autoAssignActionType"</span>: <span class="token string">"forced"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"autoAssignWeight"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"confirmationRequired"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targetfilters/5">https://management-api.host.com/rest/v1/targetfilters/5</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"autoAssignDS"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targetfilters/5/autoAssignDS">https://management-api.host.com/rest/v1/targetfilters/5/autoAssignDS</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token number">5</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-477" aria-labelledby="react-tabs-476"></div></div></div></div></div></div><div id="tag/Target-Filter-Queries/operation/deleteFilter" data-section-id="tag/Target-Filter-Queries/operation/deleteFilter" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/deleteFilter" id="operation/deleteFilter" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Target-Filter-Queries/operation/deleteFilter" aria-label="tag/Target-Filter-Queries/operation/deleteFilter"></a>Delete target filter by id<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the DELETE request of deleting a target filter query. Required permission: DELETE_TARGET</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the DELETE request of deleting a target filter query. Required permission: DELETE_TARGET</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="filterId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">filterId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA iSOCsR" disabled=""><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Target filter query not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Target filter query not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="delete" class="sc-jYnQyy jUYA-DF http-verb delete">delete</span><span class="sc-fYrVWQ gllLir">/rest/v1/targetfilters/{filterId}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/targetfilters/{filterId}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-478" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-479" tabindex="0" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-479" aria-labelledby="react-tabs-478"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-dQmiwx jCmKdj">application/json</div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"exceptionClass"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errorCode"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"info"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Target-Filter-Queries/operation/getFilters" data-section-id="tag/Target-Filter-Queries/operation/getFilters" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getFilters" id="operation/getFilters" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Target-Filter-Queries/operation/getFilters" aria-label="tag/Target-Filter-Queries/operation/getFilters"></a>Return all target filter queries<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the GET request of retrieving all target filter queries. Required permission: READ_TARGET</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the GET request of retrieving all target filter queries. Required permission: READ_TARGET</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">query<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="offset" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">offset</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Default:<!-- --> </span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">0</span></div> <div><div html="<p>The paging offset (default is 0)</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The paging offset (default is 0)</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="limit" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">limit</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Default:<!-- --> </span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">50</span></div> <div><div html="<p>The maximum number of entries in a page (default is 50)</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The maximum number of entries in a page (default is 50)</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="sort" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">sort</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The query parameter sort allows to define the sort order for the result of a query. A sort criteria
|
||
consists of the name of a field and the sort direction (ASC for ascending and DESC descending).
|
||
The sequence of the sort criteria (multiple can be used) defines the sort order of the entities
|
||
in the result.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The query parameter sort allows to define the sort order for the result of a query. A sort criteria
|
||
consists of the name of a field and the sort direction (ASC for ascending and DESC descending).
|
||
The sequence of the sort criteria (multiple can be used) defines the sort order of the entities
|
||
in the result.</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="q" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">q</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for
|
||
available fields.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for
|
||
available fields.</p>
|
||
</div></div></div></td></tr><tr class="last "><td kind="field" title="representation" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">representation</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Default:<!-- --> </span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">"compact"</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/targetfilters</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/targetfilters</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-480" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-481" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-482" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-483" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-481" aria-labelledby="react-tabs-480"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"content"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token number">1682408566380</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408566385</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"filter1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"query"</span>: <span class="token string">"name==*"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"autoAssignDistributionSet"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"autoAssignActionType"</span>: <span class="token string">"forced"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"autoAssignWeight"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"confirmationRequired"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targetfilters/5">https://management-api.host.com/rest/v1/targetfilters/5</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"autoAssignDS"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targetfilters/5/autoAssignDS">https://management-api.host.com/rest/v1/targetfilters/5/autoAssignDS</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">5</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"total"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"size"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hreflang"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deprecation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"profile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"templated"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hreflang"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deprecation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"profile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"templated"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-483" aria-labelledby="react-tabs-482"></div></div></div></div></div></div><div id="tag/Target-Filter-Queries/operation/createFilter" data-section-id="tag/Target-Filter-Queries/operation/createFilter" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/createFilter" id="operation/createFilter" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Target-Filter-Queries/operation/createFilter" aria-label="tag/Target-Filter-Queries/operation/createFilter"></a>Create target filter<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the POST request to create a new target filter query. Required permission: CREATE_TARGET</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the POST request to create a new target filter query. Required permission: CREATE_TARGET</p>
|
||
</div></div><h5 class="sc-irLvIq cnGhhy">Request Body schema: <div class="sc-jIBlqr sc-hhyKGa bjIddV lkwvLJ"><svg class="sc-ilxebA bCxWCn" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div><div class="sc-gUjWJS sc-eKzvBH sc-jnlcPO itHPsH ciWJhv gcZOqF">required</div></h5><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"></div><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="name" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">name</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class="last "><td kind="field" title="query" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">query</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">201<!-- --> </strong><div html="<p>Successfully created</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully created</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">409<!-- --> </strong><div html="<p>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.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>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.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">415<!-- --> </strong><div html="<p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="post" class="sc-jYnQyy jBKVIL http-verb post">post</span><span class="sc-fYrVWQ gllLir">/rest/v1/targetfilters</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/targetfilters</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Request samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-484" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-485" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-485" aria-labelledby="react-tabs-484"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"filterName"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"query"</span>: <span class="token string">"controllerId==example-target-*"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-486" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-487" tabindex="0" data-rttab="true">201</li><li class="tab-error" role="tab" id="react-tabs-488" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-489" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-487" aria-labelledby="react-tabs-486"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token number">1682408566380</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408566385</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"filter1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"query"</span>: <span class="token string">"name==*"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"autoAssignDistributionSet"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"autoAssignActionType"</span>: <span class="token string">"forced"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"autoAssignWeight"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"confirmationRequired"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targetfilters/5">https://management-api.host.com/rest/v1/targetfilters/5</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"autoAssignDS"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targetfilters/5/autoAssignDS">https://management-api.host.com/rest/v1/targetfilters/5/autoAssignDS</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token number">5</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-489" aria-labelledby="react-tabs-488"></div></div></div></div></div></div><div id="tag/Target-Filter-Queries/operation/getAssignedDistributionSet_1" data-section-id="tag/Target-Filter-Queries/operation/getAssignedDistributionSet_1" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getAssignedDistributionSet_1" id="operation/getAssignedDistributionSet_1" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Target-Filter-Queries/operation/getAssignedDistributionSet_1" aria-label="tag/Target-Filter-Queries/operation/getAssignedDistributionSet_1"></a>Return distribution set for auto assignment of a specific target filter<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the GET request of retrieving the auto assign distribution set. Required permission: READ_TARGET</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the GET request of retrieving the auto assign distribution set. Required permission: READ_TARGET</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="filterId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">filterId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/targetfilters/{filterId}/autoAssignDS</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/targetfilters/{filterId}/autoAssignDS</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-490" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-491" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-492" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-493" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-491" aria-labelledby="react-tabs-490"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token number">1682408574924</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408574925</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"DS"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"version"</span>: <span class="token string">"1.0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modules"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token number">1682408574921</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408574926</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"Firmware"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"version"</span>: <span class="token string">"1.0.42"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"os"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"typeName"</span>: <span class="token string">"OS"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"vendor"</span>: <span class="token string">"vendor Limited Inc, California"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"locked"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deleted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"encrypted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremodules/18">https://management-api.host.com/rest/v1/softwaremodules/18</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">18</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token number">1682408574920</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408574925</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"app runtime"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"version"</span>: <span class="token string">"1.0.25"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"runtime"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"typeName"</span>: <span class="token string">"runtime"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"vendor"</span>: <span class="token string">"vendor GmbH, Stuttgart, Germany"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"locked"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deleted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"encrypted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremodules/17">https://management-api.host.com/rest/v1/softwaremodules/17</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">17</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token number">1682408574919</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408574926</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"application"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"version"</span>: <span class="token string">"1.0.67"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"application"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"typeName"</span>: <span class="token string">"Application"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"vendor"</span>: <span class="token string">"vendor Limited, California"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"locked"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deleted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"encrypted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremodules/16">https://management-api.host.com/rest/v1/softwaremodules/16</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">16</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"requiredMigrationStep"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"test_default_ds_type"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"typeName"</span>: <span class="token string">"OS (FW) mandatory, runtime (FW) and app (SW) optional"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"complete"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deleted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"valid"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsets/6">https://management-api.host.com/rest/v1/distributionsets/6</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"modules"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsets/6/assignedSM?offset=0&limit=50">https://management-api.host.com/rest/v1/distributionsets/6/assignedSM?offset=0&limit=50</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsettypes/24">https://management-api.host.com/rest/v1/distributionsettypes/24</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsets/6/metadata?offset=0&limit=50">https://management-api.host.com/rest/v1/distributionsets/6/metadata?offset=0&limit=50</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token number">6</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-493" aria-labelledby="react-tabs-492"></div></div></div></div></div></div><div id="tag/Target-Filter-Queries/operation/postAssignedDistributionSet_1" data-section-id="tag/Target-Filter-Queries/operation/postAssignedDistributionSet_1" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/postAssignedDistributionSet_1" id="operation/postAssignedDistributionSet_1" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Target-Filter-Queries/operation/postAssignedDistributionSet_1" aria-label="tag/Target-Filter-Queries/operation/postAssignedDistributionSet_1"></a>Set auto assignment of distribution set for a target filter query<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the POST request of setting the auto assign distribution set for a target filter query. Required permissions: UPDATE_TARGET and READ_REPOSITORY</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the POST request of setting the auto assign distribution set for a target filter query. Required permissions: UPDATE_TARGET and READ_REPOSITORY</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="filterId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">filterId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><h5 class="sc-irLvIq cnGhhy">Request Body schema: <div class="sc-jIBlqr sc-hhyKGa bjIddV lkwvLJ"><svg class="sc-ilxebA bCxWCn" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div><div class="sc-gUjWJS sc-eKzvBH sc-jnlcPO itHPsH ciWJhv gcZOqF">required</div></h5><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"></div><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="id" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">id</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class=""><td kind="field" title="type" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">type</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Enum<!-- -->:</span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">"soft"</span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">"forced"</span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">"timeforced"</span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">"downloadonly"</span> </div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class=""><td kind="field" title="weight" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">weight</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class="last "><td kind="field" title="confirmationRequired" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">confirmationRequired</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">boolean</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Target filter not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Target filter not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">409<!-- --> </strong><div html="<p>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.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>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.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">415<!-- --> </strong><div html="<p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="post" class="sc-jYnQyy jBKVIL http-verb post">post</span><span class="sc-fYrVWQ gllLir">/rest/v1/targetfilters/{filterId}/autoAssignDS</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/targetfilters/{filterId}/autoAssignDS</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Request samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-494" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-495" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-495" aria-labelledby="react-tabs-494"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token number">108</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"soft"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"weight"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"confirmationRequired"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-496" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-497" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-498" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-499" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-497" aria-labelledby="react-tabs-496"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token number">1682408566380</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408566385</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"filter1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"query"</span>: <span class="token string">"name==*"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"autoAssignDistributionSet"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"autoAssignActionType"</span>: <span class="token string">"forced"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"autoAssignWeight"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"confirmationRequired"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targetfilters/5">https://management-api.host.com/rest/v1/targetfilters/5</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"autoAssignDS"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/targetfilters/5/autoAssignDS">https://management-api.host.com/rest/v1/targetfilters/5/autoAssignDS</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token number">5</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-499" aria-labelledby="react-tabs-498"></div></div></div></div></div></div><div id="tag/Target-Filter-Queries/operation/deleteAssignedDistributionSet" data-section-id="tag/Target-Filter-Queries/operation/deleteAssignedDistributionSet" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/deleteAssignedDistributionSet" id="operation/deleteAssignedDistributionSet" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Target-Filter-Queries/operation/deleteAssignedDistributionSet" aria-label="tag/Target-Filter-Queries/operation/deleteAssignedDistributionSet"></a>Remove Distribution Set for auto assignment of a target filter<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Removes the auto assign distribution set from the target filter query. Required permission: UPDATE_TARGET</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Removes the auto assign distribution set from the target filter query. Required permission: UPDATE_TARGET</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="filterId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">filterId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA iSOCsR" disabled=""><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Target filter query not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Target filter query not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="delete" class="sc-jYnQyy jUYA-DF http-verb delete">delete</span><span class="sc-fYrVWQ gllLir">/rest/v1/targetfilters/{filterId}/autoAssignDS</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/targetfilters/{filterId}/autoAssignDS</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-500" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-501" tabindex="0" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-501" aria-labelledby="react-tabs-500"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-dQmiwx jCmKdj">application/json</div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"exceptionClass"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errorCode"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"info"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Download-artifact" data-section-id="tag/Download-artifact" class="sc-eDLKkx hNzKJC"><div class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h1 class="sc-fsYfdN gqLiaw"><a class="sc-csKJxZ fNhImz" href="#tag/Download-artifact" aria-label="tag/Download-artifact"></a>Download artifact</h1></div></div><div class="sc-hLQSwg jSgyLg"><div class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS redoc-markdown " html="<p>API to download artifacts.</p>
|
||
"><p>API to download artifacts.</p>
|
||
</div></div></div><div id="tag/Download-artifact/operation/downloadArtifact_1" data-section-id="tag/Download-artifact/operation/downloadArtifact_1" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/downloadArtifact_1" id="operation/downloadArtifact_1" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Download-artifact/operation/downloadArtifact_1" aria-label="tag/Download-artifact/operation/downloadArtifact_1"></a>downloadArtifact_1<!-- --> </h2><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="softwareModuleId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">softwareModuleId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class="last "><td kind="field" title="artifactId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">artifactId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>OK</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>OK</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/softwaremodules/{softwareModuleId}/artifacts/{artifactId}/download</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/softwaremodules/{softwareModuleId}/artifacts/{artifactId}/download</div></div></div></div></div></div></div></div><div id="tag/Distribution-Set-Tags" data-section-id="tag/Distribution-Set-Tags" class="sc-eDLKkx hNzKJC"><div class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h1 class="sc-fsYfdN gqLiaw"><a class="sc-csKJxZ fNhImz" href="#tag/Distribution-Set-Tags" aria-label="tag/Distribution-Set-Tags"></a>Distribution Set Tags</h1></div></div><div class="sc-hLQSwg jSgyLg"><div class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS redoc-markdown " html="<p>REST Resource handling for DistributionSetTag CRUD operations.</p>
|
||
"><p>REST Resource handling for DistributionSetTag CRUD operations.</p>
|
||
</div></div></div><div id="tag/Distribution-Set-Tags/operation/getDistributionSetTag" data-section-id="tag/Distribution-Set-Tags/operation/getDistributionSetTag" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getDistributionSetTag" id="operation/getDistributionSetTag" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Distribution-Set-Tags/operation/getDistributionSetTag" aria-label="tag/Distribution-Set-Tags/operation/getDistributionSetTag"></a>Return single Distribution Set Tag<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the GET request of retrieving a single distribution set tag.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the GET request of retrieving a single distribution set tag.</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="distributionsetTagId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">distributionsetTagId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Distribution Set Tag not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Distribution Set Tag not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/distributionsettags/{distributionsetTagId}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/distributionsettags/{distributionsetTagId}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-502" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-503" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-504" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-505" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-503" aria-labelledby="react-tabs-502"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token number">1682408561990</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408561992</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"DsTag"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"My name is DsTag"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"colour"</span>: <span class="token string">"default"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsettags/6">https://management-api.host.com/rest/v1/distributionsettags/6</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"assignedDistributionSets"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsettags/6/assigned?offset=0&limit=50">https://management-api.host.com/rest/v1/distributionsettags/6/assigned?offset=0&limit=50</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token number">6</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-505" aria-labelledby="react-tabs-504"></div></div></div></div></div></div><div id="tag/Distribution-Set-Tags/operation/updateDistributionSetTag" data-section-id="tag/Distribution-Set-Tags/operation/updateDistributionSetTag" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/updateDistributionSetTag" id="operation/updateDistributionSetTag" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Distribution-Set-Tags/operation/updateDistributionSetTag" aria-label="tag/Distribution-Set-Tags/operation/updateDistributionSetTag"></a>Update Distribution Set Tag<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the PUT request of updating a distribution set tag.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the PUT request of updating a distribution set tag.</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="distributionsetTagId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">distributionsetTagId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><h5 class="sc-irLvIq cnGhhy">Request Body schema: <div class="sc-jIBlqr sc-hhyKGa bjIddV lkwvLJ"><svg class="sc-ilxebA bCxWCn" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div><div class="sc-gUjWJS sc-eKzvBH sc-jnlcPO itHPsH ciWJhv gcZOqF">required</div></h5><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"></div><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="name" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">name</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The name of the entity</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The name of the entity</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="description" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">description</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The description of the entity</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The description of the entity</p>
|
||
</div></div></div></td></tr><tr class="last "><td kind="field" title="colour" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">colour</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The colour of the entity</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The colour of the entity</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Distribution Set Tag not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Distribution Set Tag not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">409<!-- --> </strong><div html="<p>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.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>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.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">415<!-- --> </strong><div html="<p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="put" class="sc-jYnQyy hyHSPQ http-verb put">put</span><span class="sc-fYrVWQ gllLir">/rest/v1/distributionsettags/{distributionsetTagId}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/distributionsettags/{distributionsetTagId}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Request samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-506" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-507" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-507" aria-labelledby="react-tabs-506"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"Example name"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"Example description"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"colour"</span>: <span class="token string">"rgb(0,255,0)"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-508" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-509" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-510" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-511" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-509" aria-labelledby="react-tabs-508"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token number">1682408561990</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408561992</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"DsTag"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"My name is DsTag"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"colour"</span>: <span class="token string">"default"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsettags/6">https://management-api.host.com/rest/v1/distributionsettags/6</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"assignedDistributionSets"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsettags/6/assigned?offset=0&limit=50">https://management-api.host.com/rest/v1/distributionsettags/6/assigned?offset=0&limit=50</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token number">6</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-511" aria-labelledby="react-tabs-510"></div></div></div></div></div></div><div id="tag/Distribution-Set-Tags/operation/deleteDistributionSetTag" data-section-id="tag/Distribution-Set-Tags/operation/deleteDistributionSetTag" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/deleteDistributionSetTag" id="operation/deleteDistributionSetTag" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Distribution-Set-Tags/operation/deleteDistributionSetTag" aria-label="tag/Distribution-Set-Tags/operation/deleteDistributionSetTag"></a>Delete a single distribution set tag<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the DELETE request of deleting a single distribution set tag.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the DELETE request of deleting a single distribution set tag.</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="distributionsetTagId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">distributionsetTagId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA iSOCsR" disabled=""><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Distribution Set Tag not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Distribution Set Tag not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">409<!-- --> </strong><div html="<p>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.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>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.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">415<!-- --> </strong><div html="<p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="delete" class="sc-jYnQyy jUYA-DF http-verb delete">delete</span><span class="sc-fYrVWQ gllLir">/rest/v1/distributionsettags/{distributionsetTagId}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/distributionsettags/{distributionsetTagId}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-512" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-513" tabindex="0" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-513" aria-labelledby="react-tabs-512"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-dQmiwx jCmKdj">application/json</div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"exceptionClass"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errorCode"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"info"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Distribution-Set-Tags/operation/getAssignedDistributionSets" data-section-id="tag/Distribution-Set-Tags/operation/getAssignedDistributionSets" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getAssignedDistributionSets" id="operation/getAssignedDistributionSets" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Distribution-Set-Tags/operation/getAssignedDistributionSets" aria-label="tag/Distribution-Set-Tags/operation/getAssignedDistributionSets"></a>Return all assigned distribution sets by given tag Id<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the GET request of retrieving a list of assigned distributions.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the GET request of retrieving a list of assigned distributions.</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="distributionsetTagId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">distributionsetTagId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h5 class="sc-irLvIq cnGhhy">query<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="offset" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">offset</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Default:<!-- --> </span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">0</span></div> <div><div html="<p>The paging offset (default is 0)</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The paging offset (default is 0)</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="limit" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">limit</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Default:<!-- --> </span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">50</span></div> <div><div html="<p>The maximum number of entries in a page (default is 50)</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The maximum number of entries in a page (default is 50)</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="sort" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">sort</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The query parameter sort allows to define the sort order for the result of a query. A sort criteria
|
||
consists of the name of a field and the sort direction (ASC for ascending and DESC descending).
|
||
The sequence of the sort criteria (multiple can be used) defines the sort order of the entities
|
||
in the result.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The query parameter sort allows to define the sort order for the result of a query. A sort criteria
|
||
consists of the name of a field and the sort direction (ASC for ascending and DESC descending).
|
||
The sequence of the sort criteria (multiple can be used) defines the sort order of the entities
|
||
in the result.</p>
|
||
</div></div></div></td></tr><tr class="last "><td kind="field" title="q" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">q</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for
|
||
available fields.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for
|
||
available fields.</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Distribution Set Tag not found</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Distribution Set Tag not found</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/distributionsettags/{distributionsetTagId}/assigned</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/distributionsettags/{distributionsetTagId}/assigned</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-514" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-515" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-516" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-517" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-515" aria-labelledby="react-tabs-514"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"content"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token number">1682408574924</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408574925</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"DS"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"version"</span>: <span class="token string">"1.0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"modules"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token number">1682408574921</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408574926</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"Firmware"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"version"</span>: <span class="token string">"1.0.42"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"os"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"typeName"</span>: <span class="token string">"OS"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"vendor"</span>: <span class="token string">"vendor Limited Inc, California"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"locked"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deleted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"encrypted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremodules/18">https://management-api.host.com/rest/v1/softwaremodules/18</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">18</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token number">1682408574920</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408574925</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"app runtime"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"version"</span>: <span class="token string">"1.0.25"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"runtime"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"typeName"</span>: <span class="token string">"runtime"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"vendor"</span>: <span class="token string">"vendor GmbH, Stuttgart, Germany"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"locked"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deleted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"encrypted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremodules/17">https://management-api.host.com/rest/v1/softwaremodules/17</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">17</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token number">1682408574919</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408574926</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"application"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"version"</span>: <span class="token string">"1.0.67"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"application"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"typeName"</span>: <span class="token string">"Application"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"vendor"</span>: <span class="token string">"vendor Limited, California"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"locked"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deleted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"encrypted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremodules/16">https://management-api.host.com/rest/v1/softwaremodules/16</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">16</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"requiredMigrationStep"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"test_default_ds_type"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"typeName"</span>: <span class="token string">"OS (FW) mandatory, runtime (FW) and app (SW) optional"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"complete"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deleted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"valid"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsets/6">https://management-api.host.com/rest/v1/distributionsets/6</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"modules"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsets/6/assignedSM?offset=0&limit=50">https://management-api.host.com/rest/v1/distributionsets/6/assignedSM?offset=0&limit=50</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsettypes/24">https://management-api.host.com/rest/v1/distributionsettypes/24</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsets/6/metadata?offset=0&limit=50">https://management-api.host.com/rest/v1/distributionsets/6/metadata?offset=0&limit=50</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">6</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"total"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"size"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hreflang"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deprecation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"profile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"templated"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hreflang"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deprecation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"profile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"templated"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-517" aria-labelledby="react-tabs-516"></div></div></div></div></div></div><div id="tag/Distribution-Set-Tags/operation/assignDistributionSetsPut" data-section-id="tag/Distribution-Set-Tags/operation/assignDistributionSetsPut" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/assignDistributionSetsPut" id="operation/assignDistributionSetsPut" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Distribution-Set-Tags/operation/assignDistributionSetsPut" aria-label="tag/Distribution-Set-Tags/operation/assignDistributionSetsPut"></a>assignDistributionSetsPut<!-- --> </h2><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="distributionsetTagId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">distributionsetTagId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><h5 class="sc-irLvIq cnGhhy">Request Body schema: <div class="sc-jIBlqr sc-hhyKGa bjIddV lkwvLJ"><svg class="sc-ilxebA bCxWCn" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div><div class="sc-gUjWJS sc-eKzvBH sc-jnlcPO itHPsH ciWJhv gcZOqF">required</div></h5><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"></div><div><div class="sc-bBkKde cplVKI"> Array </div><div class="sc-bbxCgr iZgtJR"><div><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></div></div><div class="sc-iuOOrT hPMvVd"></div></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA iSOCsR" disabled=""><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>OK</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>OK</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="put" class="sc-jYnQyy hyHSPQ http-verb put">put</span><span class="sc-fYrVWQ gllLir">/rest/v1/distributionsettags/{distributionsetTagId}/assigned</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/distributionsettags/{distributionsetTagId}/assigned</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Request samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-518" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-519" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-519" aria-labelledby="react-tabs-518"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">0</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Distribution-Set-Tags/operation/assignDistributionSets" data-section-id="tag/Distribution-Set-Tags/operation/assignDistributionSets" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/assignDistributionSets" id="operation/assignDistributionSets" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Distribution-Set-Tags/operation/assignDistributionSets" aria-label="tag/Distribution-Set-Tags/operation/assignDistributionSets"></a>Assign distribution sets to the given tag id<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the POST request of distribution assignment. Already assigned distribution will be ignored.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the POST request of distribution assignment. Already assigned distribution will be ignored.</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="distributionsetTagId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">distributionsetTagId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><h5 class="sc-irLvIq cnGhhy">Request Body schema: <div class="sc-jIBlqr sc-hhyKGa bjIddV lkwvLJ"><svg class="sc-ilxebA bCxWCn" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div><div class="sc-gUjWJS sc-eKzvBH sc-jnlcPO itHPsH ciWJhv gcZOqF">required</div></h5><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"></div><div><div class="sc-bBkKde cplVKI"> Array </div><div class="sc-bbxCgr iZgtJR"><div><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></div></div><div class="sc-iuOOrT hPMvVd"></div></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA iSOCsR" disabled=""><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Not Found - e.g. a distribution set or tags are not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Not Found - e.g. a distribution set or tags are not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">409<!-- --> </strong><div html="<p>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.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>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.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">415<!-- --> </strong><div html="<p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="post" class="sc-jYnQyy jBKVIL http-verb post">post</span><span class="sc-fYrVWQ gllLir">/rest/v1/distributionsettags/{distributionsetTagId}/assigned</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/distributionsettags/{distributionsetTagId}/assigned</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Request samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-520" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-521" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-521" aria-labelledby="react-tabs-520"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">0</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-522" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-523" tabindex="0" data-rttab="true">400</li><li class="tab-error" role="tab" id="react-tabs-524" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-525" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-523" aria-labelledby="react-tabs-522"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-dQmiwx jCmKdj">application/json</div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"exceptionClass"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errorCode"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"info"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-525" aria-labelledby="react-tabs-524"></div></div></div></div></div></div><div id="tag/Distribution-Set-Tags/operation/unassignDistributionSets" data-section-id="tag/Distribution-Set-Tags/operation/unassignDistributionSets" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/unassignDistributionSets" id="operation/unassignDistributionSets" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Distribution-Set-Tags/operation/unassignDistributionSets" aria-label="tag/Distribution-Set-Tags/operation/unassignDistributionSets"></a>Unassign multiple distribution sets from the given tag id<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the DELETE request of unassign the given distribution.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the DELETE request of unassign the given distribution.</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="distributionsetTagId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">distributionsetTagId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><h5 class="sc-irLvIq cnGhhy">Request Body schema: <span class="sc-gYrqIg hJSqDi">application/json</span><div class="sc-gUjWJS sc-eKzvBH sc-jnlcPO itHPsH ciWJhv gcZOqF">required</div></h5><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"></div><div><div class="sc-bBkKde cplVKI"> Array </div><div class="sc-bbxCgr iZgtJR"><div><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></div></div><div class="sc-iuOOrT hPMvVd"></div></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA iSOCsR" disabled=""><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Not Found - e.g. a distribution set or tags are not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Not Found - e.g. a distribution set or tags are not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="delete" class="sc-jYnQyy jUYA-DF http-verb delete">delete</span><span class="sc-fYrVWQ gllLir">/rest/v1/distributionsettags/{distributionsetTagId}/assigned</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/distributionsettags/{distributionsetTagId}/assigned</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Request samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-526" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-527" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-527" aria-labelledby="react-tabs-526"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-dQmiwx jCmKdj">application/json</div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">0</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-528" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-529" tabindex="0" data-rttab="true">400</li><li class="tab-error" role="tab" id="react-tabs-530" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-531" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-529" aria-labelledby="react-tabs-528"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-dQmiwx jCmKdj">application/json</div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"exceptionClass"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errorCode"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"info"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-531" aria-labelledby="react-tabs-530"></div></div></div></div></div></div><div id="tag/Distribution-Set-Tags/operation/getDistributionSetTags" data-section-id="tag/Distribution-Set-Tags/operation/getDistributionSetTags" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getDistributionSetTags" id="operation/getDistributionSetTags" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Distribution-Set-Tags/operation/getDistributionSetTags" aria-label="tag/Distribution-Set-Tags/operation/getDistributionSetTags"></a>Return all Distribution Set Tags<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the GET request of retrieving all distribution set tags.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the GET request of retrieving all distribution set tags.</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">query<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="offset" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">offset</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Default:<!-- --> </span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">0</span></div> <div><div html="<p>The paging offset (default is 0)</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The paging offset (default is 0)</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="limit" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">limit</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Default:<!-- --> </span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">50</span></div> <div><div html="<p>The maximum number of entries in a page (default is 50)</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The maximum number of entries in a page (default is 50)</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="sort" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">sort</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The query parameter sort allows to define the sort order for the result of a query. A sort criteria
|
||
consists of the name of a field and the sort direction (ASC for ascending and DESC descending).
|
||
The sequence of the sort criteria (multiple can be used) defines the sort order of the entities
|
||
in the result.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The query parameter sort allows to define the sort order for the result of a query. A sort criteria
|
||
consists of the name of a field and the sort direction (ASC for ascending and DESC descending).
|
||
The sequence of the sort criteria (multiple can be used) defines the sort order of the entities
|
||
in the result.</p>
|
||
</div></div></div></td></tr><tr class="last "><td kind="field" title="q" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">q</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for
|
||
available fields.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for
|
||
available fields.</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/distributionsettags</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/distributionsettags</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-532" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-533" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-534" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-535" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-533" aria-labelledby="react-tabs-532"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"content"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token number">1682408561990</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408561992</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"DsTag"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"My name is DsTag"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"colour"</span>: <span class="token string">"default"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsettags/6">https://management-api.host.com/rest/v1/distributionsettags/6</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"assignedDistributionSets"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsettags/6/assigned?offset=0&limit=50">https://management-api.host.com/rest/v1/distributionsettags/6/assigned?offset=0&limit=50</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">6</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"total"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"size"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hreflang"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deprecation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"profile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"templated"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hreflang"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deprecation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"profile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"templated"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-535" aria-labelledby="react-tabs-534"></div></div></div></div></div></div><div id="tag/Distribution-Set-Tags/operation/createDistributionSetTags" data-section-id="tag/Distribution-Set-Tags/operation/createDistributionSetTags" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/createDistributionSetTags" id="operation/createDistributionSetTags" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Distribution-Set-Tags/operation/createDistributionSetTags" aria-label="tag/Distribution-Set-Tags/operation/createDistributionSetTags"></a>Creates new Distribution Set Tags<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the POST request of creating new distribution set tag. The request body must always be a list of distribution set tags.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the POST request of creating new distribution set tag. The request body must always be a list of distribution set tags.</p>
|
||
</div></div><h5 class="sc-irLvIq cnGhhy">Request Body schema: <div class="sc-jIBlqr sc-hhyKGa bjIddV lkwvLJ"><svg class="sc-ilxebA bCxWCn" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div><div class="sc-gUjWJS sc-eKzvBH sc-jnlcPO itHPsH ciWJhv gcZOqF">required</div></h5><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"></div><div><div class="sc-bBkKde cplVKI"> Array </div><div class="sc-bbxCgr iZgtJR"><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="name" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">name</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The name of the entity</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The name of the entity</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="description" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">description</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The description of the entity</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The description of the entity</p>
|
||
</div></div></div></td></tr><tr class="last "><td kind="field" title="colour" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">colour</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The colour of the entity</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The colour of the entity</p>
|
||
</div></div></div></td></tr></tbody></table></div><div class="sc-iuOOrT hPMvVd"></div></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">201<!-- --> </strong><div html="<p>Successfully created</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully created</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">409<!-- --> </strong><div html="<p>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.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>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.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">415<!-- --> </strong><div html="<p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="post" class="sc-jYnQyy jBKVIL http-verb post">post</span><span class="sc-fYrVWQ gllLir">/rest/v1/distributionsettags</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/distributionsettags</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Request samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-536" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-537" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-537" aria-labelledby="react-tabs-536"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"Example name"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"Example description"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"colour"</span>: <span class="token string">"rgb(0,255,0)"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-538" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-539" tabindex="0" data-rttab="true">201</li><li class="tab-error" role="tab" id="react-tabs-540" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-541" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-539" aria-labelledby="react-tabs-538"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token number">1682408561990</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408561992</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"DsTag"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"My name is DsTag"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"colour"</span>: <span class="token string">"default"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsettags/6">https://management-api.host.com/rest/v1/distributionsettags/6</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"assignedDistributionSets"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsettags/6/assigned?offset=0&limit=50">https://management-api.host.com/rest/v1/distributionsettags/6/assigned?offset=0&limit=50</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">6</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-541" aria-labelledby="react-tabs-540"></div></div></div></div></div></div><div id="tag/Distribution-Set-Tags/operation/assignDistributionSet" data-section-id="tag/Distribution-Set-Tags/operation/assignDistributionSet" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/assignDistributionSet" id="operation/assignDistributionSet" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Distribution-Set-Tags/operation/assignDistributionSet" aria-label="tag/Distribution-Set-Tags/operation/assignDistributionSet"></a>Assign distribution set to the given tag id<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the POST request of distribution assignment. Already assigned distribution will be ignored.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the POST request of distribution assignment. Already assigned distribution will be ignored.</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="distributionsetTagId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">distributionsetTagId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class="last "><td kind="field" title="distributionsetId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">distributionsetId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA iSOCsR" disabled=""><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">409<!-- --> </strong><div html="<p>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.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>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.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">415<!-- --> </strong><div html="<p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="post" class="sc-jYnQyy jBKVIL http-verb post">post</span><span class="sc-fYrVWQ gllLir">/rest/v1/distributionsettags/{distributionsetTagId}/assigned/{distributionsetId}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/distributionsettags/{distributionsetTagId}/assigned/{distributionsetId}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-542" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-543" tabindex="0" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-543" aria-labelledby="react-tabs-542"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-dQmiwx jCmKdj">application/json</div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"exceptionClass"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errorCode"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"info"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Distribution-Set-Tags/operation/unassignDistributionSet" data-section-id="tag/Distribution-Set-Tags/operation/unassignDistributionSet" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/unassignDistributionSet" id="operation/unassignDistributionSet" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Distribution-Set-Tags/operation/unassignDistributionSet" aria-label="tag/Distribution-Set-Tags/operation/unassignDistributionSet"></a>Unassign one distribution set from the given tag id<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the DELETE request of unassign the given distribution.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the DELETE request of unassign the given distribution.</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="distributionsetTagId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">distributionsetTagId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class="last "><td kind="field" title="distributionsetId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">distributionsetId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA iSOCsR" disabled=""><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Distribution Set Tag not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Distribution Set Tag not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="delete" class="sc-jYnQyy jUYA-DF http-verb delete">delete</span><span class="sc-fYrVWQ gllLir">/rest/v1/distributionsettags/{distributionsetTagId}/assigned/{distributionsetId}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/distributionsettags/{distributionsetTagId}/assigned/{distributionsetId}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-544" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-545" tabindex="0" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-545" aria-labelledby="react-tabs-544"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-dQmiwx jCmKdj">application/json</div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"exceptionClass"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errorCode"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"info"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Distribution-Set-Types" data-section-id="tag/Distribution-Set-Types" class="sc-eDLKkx hNzKJC"><div class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h1 class="sc-fsYfdN gqLiaw"><a class="sc-csKJxZ fNhImz" href="#tag/Distribution-Set-Types" aria-label="tag/Distribution-Set-Types"></a>Distribution Set Types</h1></div></div><div class="sc-hLQSwg jSgyLg"><div class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS redoc-markdown " html="<p>REST Resource handling for DistributionSetType CRUD operations.</p>
|
||
"><p>REST Resource handling for DistributionSetType CRUD operations.</p>
|
||
</div></div></div><div id="tag/Distribution-Set-Types/operation/getDistributionSetType" data-section-id="tag/Distribution-Set-Types/operation/getDistributionSetType" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getDistributionSetType" id="operation/getDistributionSetType" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Distribution-Set-Types/operation/getDistributionSetType" aria-label="tag/Distribution-Set-Types/operation/getDistributionSetType"></a>Return single Distribution Set Type<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the GET request of retrieving a single distribution set type. Required Permission: READ_REPOSITORY</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the GET request of retrieving a single distribution set type. Required Permission: READ_REPOSITORY</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="distributionSetTypeId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">distributionSetTypeId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Distribution Set Type not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Distribution Set Type not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/distributionsettypes/{distributionSetTypeId}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/distributionsettypes/{distributionSetTypeId}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-546" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-547" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-548" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-549" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-547" aria-labelledby="react-tabs-546"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token number">1682408579418</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408579459</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"OS (FW) mandatory, runtime (FW) and app (SW) optional"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"Desc1234"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key"</span>: <span class="token string">"test_default_ds_type"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deleted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"colour"</span>: <span class="token string">"rgb(86,37,99)"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsettypes/14">https://management-api.host.com/rest/v1/distributionsettypes/14</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"mandatorymodules"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsettypes/14/mandatorymoduletypes">https://management-api.host.com/rest/v1/distributionsettypes/14/mandatorymoduletypes</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"optionalmodules"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsettypes/14/optionalmoduletypes">https://management-api.host.com/rest/v1/distributionsettypes/14/optionalmoduletypes</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token number">14</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-549" aria-labelledby="react-tabs-548"></div></div></div></div></div></div><div id="tag/Distribution-Set-Types/operation/updateDistributionSetType" data-section-id="tag/Distribution-Set-Types/operation/updateDistributionSetType" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/updateDistributionSetType" id="operation/updateDistributionSetType" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Distribution-Set-Types/operation/updateDistributionSetType" aria-label="tag/Distribution-Set-Types/operation/updateDistributionSetType"></a>Update Distribution Set Type<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the PUT request for a single distribution set type. Required Permission: UPDATE_REPOSITORY</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the PUT request for a single distribution set type. Required Permission: UPDATE_REPOSITORY</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="distributionSetTypeId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">distributionSetTypeId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><h5 class="sc-irLvIq cnGhhy">Request Body schema: <div class="sc-jIBlqr sc-hhyKGa bjIddV lkwvLJ"><svg class="sc-ilxebA bCxWCn" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div><div class="sc-gUjWJS sc-eKzvBH sc-jnlcPO itHPsH ciWJhv gcZOqF">required</div></h5><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"></div><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="description" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">description</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The description of the entity</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The description of the entity</p>
|
||
</div></div></div></td></tr><tr class="last "><td kind="field" title="colour" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">colour</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The colour of the entity</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The colour of the entity</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Distribution Set Type not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Distribution Set Type not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">409<!-- --> </strong><div html="<p>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.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>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.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">415<!-- --> </strong><div html="<p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="put" class="sc-jYnQyy hyHSPQ http-verb put">put</span><span class="sc-fYrVWQ gllLir">/rest/v1/distributionsettypes/{distributionSetTypeId}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/distributionsettypes/{distributionSetTypeId}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Request samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-550" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-551" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-551" aria-labelledby="react-tabs-550"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"Example description"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"colour"</span>: <span class="token string">"rgb(86,37,99)"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-552" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-553" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-554" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-555" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-553" aria-labelledby="react-tabs-552"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token number">1682408579418</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408579459</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"OS (FW) mandatory, runtime (FW) and app (SW) optional"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"Desc1234"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key"</span>: <span class="token string">"test_default_ds_type"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deleted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"colour"</span>: <span class="token string">"rgb(86,37,99)"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsettypes/14">https://management-api.host.com/rest/v1/distributionsettypes/14</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"mandatorymodules"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsettypes/14/mandatorymoduletypes">https://management-api.host.com/rest/v1/distributionsettypes/14/mandatorymoduletypes</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"optionalmodules"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsettypes/14/optionalmoduletypes">https://management-api.host.com/rest/v1/distributionsettypes/14/optionalmoduletypes</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token number">14</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-555" aria-labelledby="react-tabs-554"></div></div></div></div></div></div><div id="tag/Distribution-Set-Types/operation/deleteDistributionSetType" data-section-id="tag/Distribution-Set-Types/operation/deleteDistributionSetType" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/deleteDistributionSetType" id="operation/deleteDistributionSetType" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Distribution-Set-Types/operation/deleteDistributionSetType" aria-label="tag/Distribution-Set-Types/operation/deleteDistributionSetType"></a>Delete Distribution Set Type by Id<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the DELETE request for a single distribution set type. Required Permission: DELETE_REPOSITORY</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the DELETE request for a single distribution set type. Required Permission: DELETE_REPOSITORY</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="distributionSetTypeId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">distributionSetTypeId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA iSOCsR" disabled=""><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Distribution Set Type not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Distribution Set Type not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="delete" class="sc-jYnQyy jUYA-DF http-verb delete">delete</span><span class="sc-fYrVWQ gllLir">/rest/v1/distributionsettypes/{distributionSetTypeId}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/distributionsettypes/{distributionSetTypeId}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-556" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-557" tabindex="0" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-557" aria-labelledby="react-tabs-556"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-dQmiwx jCmKdj">application/json</div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"exceptionClass"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errorCode"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"info"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Distribution-Set-Types/operation/getDistributionSetTypes" data-section-id="tag/Distribution-Set-Types/operation/getDistributionSetTypes" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getDistributionSetTypes" id="operation/getDistributionSetTypes" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Distribution-Set-Types/operation/getDistributionSetTypes" aria-label="tag/Distribution-Set-Types/operation/getDistributionSetTypes"></a>Return all Distribution Set Types<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the GET request of retrieving all distribution set types. Required Permission: READ_REPOSITORY</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the GET request of retrieving all distribution set types. Required Permission: READ_REPOSITORY</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">query<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="offset" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">offset</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Default:<!-- --> </span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">0</span></div> <div><div html="<p>The paging offset (default is 0)</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The paging offset (default is 0)</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="limit" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">limit</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div><div><span class="sc-gUjWJS itHPsH"> <!-- -->Default:<!-- --> </span> <span class="sc-gUjWJS sc-ldgOGP itHPsH cRxwgg">50</span></div> <div><div html="<p>The maximum number of entries in a page (default is 50)</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The maximum number of entries in a page (default is 50)</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="sort" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">sort</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The query parameter sort allows to define the sort order for the result of a query. A sort criteria
|
||
consists of the name of a field and the sort direction (ASC for ascending and DESC descending).
|
||
The sequence of the sort criteria (multiple can be used) defines the sort order of the entities
|
||
in the result.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The query parameter sort allows to define the sort order for the result of a query. A sort criteria
|
||
consists of the name of a field and the sort direction (ASC for ascending and DESC descending).
|
||
The sequence of the sort criteria (multiple can be used) defines the sort order of the entities
|
||
in the result.</p>
|
||
</div></div></div></td></tr><tr class="last "><td kind="field" title="q" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">q</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for
|
||
available fields.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for
|
||
available fields.</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/distributionsettypes</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/distributionsettypes</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-558" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-559" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-560" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-561" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-559" aria-labelledby="react-tabs-558"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"content"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token number">1682408579418</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408579459</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"OS (FW) mandatory, runtime (FW) and app (SW) optional"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"Desc1234"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"key"</span>: <span class="token string">"test_default_ds_type"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deleted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"colour"</span>: <span class="token string">"rgb(86,37,99)"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsettypes/14">https://management-api.host.com/rest/v1/distributionsettypes/14</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"mandatorymodules"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsettypes/14/mandatorymoduletypes">https://management-api.host.com/rest/v1/distributionsettypes/14/mandatorymoduletypes</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"optionalmodules"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsettypes/14/optionalmoduletypes">https://management-api.host.com/rest/v1/distributionsettypes/14/optionalmoduletypes</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">14</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"total"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"size"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hreflang"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deprecation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"profile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"templated"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hreflang"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deprecation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"profile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"templated"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-561" aria-labelledby="react-tabs-560"></div></div></div></div></div></div><div id="tag/Distribution-Set-Types/operation/createDistributionSetTypes" data-section-id="tag/Distribution-Set-Types/operation/createDistributionSetTypes" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/createDistributionSetTypes" id="operation/createDistributionSetTypes" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Distribution-Set-Types/operation/createDistributionSetTypes" aria-label="tag/Distribution-Set-Types/operation/createDistributionSetTypes"></a>Create new distribution set types<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the POST request for creating new distribution set types. The request body must always be a list of types. Required Permission: CREATE_REPOSITORY</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the POST request for creating new distribution set types. The request body must always be a list of types. Required Permission: CREATE_REPOSITORY</p>
|
||
</div></div><h5 class="sc-irLvIq cnGhhy">Request Body schema: <div class="sc-jIBlqr sc-hhyKGa bjIddV lkwvLJ"><svg class="sc-ilxebA bCxWCn" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div><div class="sc-gUjWJS sc-eKzvBH sc-jnlcPO itHPsH ciWJhv gcZOqF">required</div></h5><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"></div><div><div class="sc-bBkKde cplVKI"> Array </div><div class="sc-bbxCgr iZgtJR"><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="description" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">description</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The description of the entity</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The description of the entity</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="colour" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">colour</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The colour of the entity</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The colour of the entity</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="name" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">name</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>The name of the entity</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>The name of the entity</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="key" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">key</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="<p>Functional key of the distribution set type</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Functional key of the distribution set type</p>
|
||
</div></div></div></td></tr><tr class=""><td kind="field" title="mandatorymodules" class="sc-hABBmJ sc-fHejqy sc-jiaSqj cqoAxn hfWKVF gIkRoy"><span class="sc-ifyrAs hIHfpT"></span><button aria-label="expand mandatorymodules"><span class="property-name">mandatorymodules</span><svg class="sc-eTNRI jIsRbK" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY">Array of </span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">objects</span><span class="sc-gUjWJS sc-jgraLO itHPsH iUxudT"> (<!-- -->MgmtSoftwareModuleTypeAssignment<!-- -->) </span></div> <div><div html="<p>Mandatory module type IDs</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Mandatory module type IDs</p>
|
||
</div></div></div></td></tr><tr class="last "><td kind="field" title="optionalmodules" class="sc-hABBmJ sc-fHejqy sc-jiaSqj cqoAxn hfWKVF gIkRoy"><span class="sc-ifyrAs hIHfpT"></span><button aria-label="expand optionalmodules"><span class="property-name">optionalmodules</span><svg class="sc-eTNRI jIsRbK" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY">Array of </span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">objects</span><span class="sc-gUjWJS sc-jgraLO itHPsH iUxudT"> (<!-- -->MgmtSoftwareModuleTypeAssignment<!-- -->) </span></div> <div><div html="<p>Optional module type IDs</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Optional module type IDs</p>
|
||
</div></div></div></td></tr></tbody></table></div><div class="sc-iuOOrT hPMvVd"></div></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">201<!-- --> </strong><div html="<p>Successfully created</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully created</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">409<!-- --> </strong><div html="<p>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.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>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.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">415<!-- --> </strong><div html="<p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="post" class="sc-jYnQyy jBKVIL http-verb post">post</span><span class="sc-fYrVWQ gllLir">/rest/v1/distributionsettypes</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/distributionsettypes</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Request samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-562" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-563" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-563" aria-labelledby="react-tabs-562"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"Example description"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"colour"</span>: <span class="token string">"rgb(86,37,99)"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"Example type name"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"key"</span>: <span class="token string">"Example key"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"mandatorymodules"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">108</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"optionalmodules"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">108</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-564" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-565" tabindex="0" data-rttab="true">201</li><li class="tab-error" role="tab" id="react-tabs-566" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-567" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-565" aria-labelledby="react-tabs-564"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"createdBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token number">1682408579418</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408579459</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"OS (FW) mandatory, runtime (FW) and app (SW) optional"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"Desc1234"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"key"</span>: <span class="token string">"test_default_ds_type"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deleted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"colour"</span>: <span class="token string">"rgb(86,37,99)"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsettypes/14">https://management-api.host.com/rest/v1/distributionsettypes/14</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"mandatorymodules"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsettypes/14/mandatorymoduletypes">https://management-api.host.com/rest/v1/distributionsettypes/14/mandatorymoduletypes</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"optionalmodules"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/distributionsettypes/14/optionalmoduletypes">https://management-api.host.com/rest/v1/distributionsettypes/14/optionalmoduletypes</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">14</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-567" aria-labelledby="react-tabs-566"></div></div></div></div></div></div><div id="tag/Distribution-Set-Types/operation/getOptionalModules" data-section-id="tag/Distribution-Set-Types/operation/getOptionalModules" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getOptionalModules" id="operation/getOptionalModules" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Distribution-Set-Types/operation/getOptionalModules" aria-label="tag/Distribution-Set-Types/operation/getOptionalModules"></a>Return optional Software Module Types in a Distribution Set Type<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the GET request of retrieving the list of optional software module types in that distribution set type. Required Permission: READ_REPOSITORY</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the GET request of retrieving the list of optional software module types in that distribution set type. Required Permission: READ_REPOSITORY</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="distributionSetTypeId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">distributionSetTypeId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Distribution Set Type not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Distribution Set Type not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/distributionsettypes/{distributionSetTypeId}/optionalmoduletypes</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/distributionsettypes/{distributionSetTypeId}/optionalmoduletypes</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-568" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-569" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-570" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-571" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-569" aria-labelledby="react-tabs-568"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"createdBy"</span>: <span class="token string">"system"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token number">1682408579390</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408579394</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"Application"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"Updated description."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"key"</span>: <span class="token string">"application"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"maxAssignments"</span>: <span class="token number">2147483647</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deleted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremoduletypes/4">https://management-api.host.com/rest/v1/softwaremoduletypes/4</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">4</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-571" aria-labelledby="react-tabs-570"></div></div></div></div></div></div><div id="tag/Distribution-Set-Types/operation/addOptionalModule" data-section-id="tag/Distribution-Set-Types/operation/addOptionalModule" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/addOptionalModule" id="operation/addOptionalModule" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Distribution-Set-Types/operation/addOptionalModule" aria-label="tag/Distribution-Set-Types/operation/addOptionalModule"></a>Add optional Software Module Type to a Distribution Set Type<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>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</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>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</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="distributionSetTypeId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">distributionSetTypeId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><h5 class="sc-irLvIq cnGhhy">Request Body schema: <div class="sc-jIBlqr sc-hhyKGa bjIddV lkwvLJ"><svg class="sc-ilxebA bCxWCn" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div><div class="sc-gUjWJS sc-eKzvBH sc-jnlcPO itHPsH ciWJhv gcZOqF">required</div></h5><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"></div><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="id" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">id</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA iSOCsR" disabled=""><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Distribution Set Type not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Distribution Set Type not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">409<!-- --> </strong><div html="<p>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.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>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.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">415<!-- --> </strong><div html="<p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="post" class="sc-jYnQyy jBKVIL http-verb post">post</span><span class="sc-fYrVWQ gllLir">/rest/v1/distributionsettypes/{distributionSetTypeId}/optionalmoduletypes</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/distributionsettypes/{distributionSetTypeId}/optionalmoduletypes</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Request samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-572" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-573" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-573" aria-labelledby="react-tabs-572"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token number">108</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-574" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-575" tabindex="0" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-575" aria-labelledby="react-tabs-574"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-dQmiwx jCmKdj">application/json</div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"exceptionClass"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errorCode"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"info"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Distribution-Set-Types/operation/getMandatoryModules" data-section-id="tag/Distribution-Set-Types/operation/getMandatoryModules" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getMandatoryModules" id="operation/getMandatoryModules" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Distribution-Set-Types/operation/getMandatoryModules" aria-label="tag/Distribution-Set-Types/operation/getMandatoryModules"></a>Return mandatory Software Module Types in a Distribution Set Type<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the GET request of retrieving the list of mandatory software module types in that distribution set type. Required Permission: READ_REPOSITORY</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the GET request of retrieving the list of mandatory software module types in that distribution set type. Required Permission: READ_REPOSITORY</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="distributionSetTypeId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">distributionSetTypeId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Distribution Set Type not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Distribution Set Type not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/distributionsettypes/{distributionSetTypeId}/mandatorymoduletypes</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/distributionsettypes/{distributionSetTypeId}/mandatorymoduletypes</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-576" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-577" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-578" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-579" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-577" aria-labelledby="react-tabs-576"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"createdBy"</span>: <span class="token string">"system"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token number">1682408579390</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408579394</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"Application"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"Updated description."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"key"</span>: <span class="token string">"application"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"maxAssignments"</span>: <span class="token number">2147483647</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deleted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremoduletypes/4">https://management-api.host.com/rest/v1/softwaremoduletypes/4</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">4</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-579" aria-labelledby="react-tabs-578"></div></div></div></div></div></div><div id="tag/Distribution-Set-Types/operation/addMandatoryModule" data-section-id="tag/Distribution-Set-Types/operation/addMandatoryModule" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/addMandatoryModule" id="operation/addMandatoryModule" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Distribution-Set-Types/operation/addMandatoryModule" aria-label="tag/Distribution-Set-Types/operation/addMandatoryModule"></a>Add mandatory Software Module Type to a Distribution Set Type<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>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</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>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</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="distributionSetTypeId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">distributionSetTypeId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><h5 class="sc-irLvIq cnGhhy">Request Body schema: <div class="sc-jIBlqr sc-hhyKGa bjIddV lkwvLJ"><svg class="sc-ilxebA bCxWCn" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div><div class="sc-gUjWJS sc-eKzvBH sc-jnlcPO itHPsH ciWJhv gcZOqF">required</div></h5><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"></div><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="id" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">id</span></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA iSOCsR" disabled=""><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Distribution Set Type not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Distribution Set Type not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">409<!-- --> </strong><div html="<p>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.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>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.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">415<!-- --> </strong><div html="<p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="post" class="sc-jYnQyy jBKVIL http-verb post">post</span><span class="sc-fYrVWQ gllLir">/rest/v1/distributionsettypes/{distributionSetTypeId}/mandatorymoduletypes</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/distributionsettypes/{distributionSetTypeId}/mandatorymoduletypes</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Request samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-580" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-581" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-581" aria-labelledby="react-tabs-580"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token number">108</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-582" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-583" tabindex="0" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-583" aria-labelledby="react-tabs-582"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-dQmiwx jCmKdj">application/json</div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"exceptionClass"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errorCode"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"info"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Distribution-Set-Types/operation/getOptionalModule" data-section-id="tag/Distribution-Set-Types/operation/getOptionalModule" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getOptionalModule" id="operation/getOptionalModule" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Distribution-Set-Types/operation/getOptionalModule" aria-label="tag/Distribution-Set-Types/operation/getOptionalModule"></a>Return single optional Software Module Type in a Distribution Set Type<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the GET request of retrieving the single optional software module type in that distribution set type. Required Permission: READ_REPOSITORY</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the GET request of retrieving the single optional software module type in that distribution set type. Required Permission: READ_REPOSITORY</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="distributionSetTypeId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">distributionSetTypeId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class="last "><td kind="field" title="softwareModuleTypeId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">softwareModuleTypeId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Distribution Set Type not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Distribution Set Type not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/distributionsettypes/{distributionSetTypeId}/optionalmoduletypes/{softwareModuleTypeId}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/distributionsettypes/{distributionSetTypeId}/optionalmoduletypes/{softwareModuleTypeId}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-584" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-585" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-586" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-587" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-585" aria-labelledby="react-tabs-584"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"createdBy"</span>: <span class="token string">"system"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token number">1682408579390</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408579394</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"Application"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"Updated description."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key"</span>: <span class="token string">"application"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"maxAssignments"</span>: <span class="token number">2147483647</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deleted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremoduletypes/4">https://management-api.host.com/rest/v1/softwaremoduletypes/4</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token number">4</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-587" aria-labelledby="react-tabs-586"></div></div></div></div></div></div><div id="tag/Distribution-Set-Types/operation/removeOptionalModule" data-section-id="tag/Distribution-Set-Types/operation/removeOptionalModule" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/removeOptionalModule" id="operation/removeOptionalModule" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Distribution-Set-Types/operation/removeOptionalModule" aria-label="tag/Distribution-Set-Types/operation/removeOptionalModule"></a>Delete an optional module from a Distribution Set Type<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>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</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>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</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="distributionSetTypeId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">distributionSetTypeId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class="last "><td kind="field" title="softwareModuleTypeId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">softwareModuleTypeId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA iSOCsR" disabled=""><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Distribution Set Type not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Distribution Set Type not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="delete" class="sc-jYnQyy jUYA-DF http-verb delete">delete</span><span class="sc-fYrVWQ gllLir">/rest/v1/distributionsettypes/{distributionSetTypeId}/optionalmoduletypes/{softwareModuleTypeId}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/distributionsettypes/{distributionSetTypeId}/optionalmoduletypes/{softwareModuleTypeId}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-588" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-589" tabindex="0" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-589" aria-labelledby="react-tabs-588"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-dQmiwx jCmKdj">application/json</div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"exceptionClass"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errorCode"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"info"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Distribution-Set-Types/operation/getMandatoryModule" data-section-id="tag/Distribution-Set-Types/operation/getMandatoryModule" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getMandatoryModule" id="operation/getMandatoryModule" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Distribution-Set-Types/operation/getMandatoryModule" aria-label="tag/Distribution-Set-Types/operation/getMandatoryModule"></a>Return single mandatory Software Module Type in a Distribution Set Type<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the GET request of retrieving the single mandatory software module type in that distribution set type. Required Permission: READ_REPOSITORY</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the GET request of retrieving the single mandatory software module type in that distribution set type. Required Permission: READ_REPOSITORY</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="distributionSetTypeId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">distributionSetTypeId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class="last "><td kind="field" title="softwareModuleTypeId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">softwareModuleTypeId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Distribution Set Type not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Distribution Set Type not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/distributionsettypes/{distributionSetTypeId}/mandatorymoduletypes/{softwareModuleTypeId}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/distributionsettypes/{distributionSetTypeId}/mandatorymoduletypes/{softwareModuleTypeId}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-590" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-591" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-592" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-593" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-591" aria-labelledby="react-tabs-590"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"createdBy"</span>: <span class="token string">"system"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token number">1682408579390</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedBy"</span>: <span class="token string">"bumlux"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastModifiedAt"</span>: <span class="token number">1682408579394</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"Application"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"Updated description."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key"</span>: <span class="token string">"application"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"maxAssignments"</span>: <span class="token number">2147483647</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deleted"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/softwaremoduletypes/4">https://management-api.host.com/rest/v1/softwaremoduletypes/4</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token number">4</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-593" aria-labelledby="react-tabs-592"></div></div></div></div></div></div><div id="tag/Distribution-Set-Types/operation/removeMandatoryModule" data-section-id="tag/Distribution-Set-Types/operation/removeMandatoryModule" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/removeMandatoryModule" id="operation/removeMandatoryModule" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/Distribution-Set-Types/operation/removeMandatoryModule" aria-label="tag/Distribution-Set-Types/operation/removeMandatoryModule"></a>Delete a mandatory module from a Distribution Set Type<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>Handles the DELETE request for removing a software module type from a single distribution set type. Required Permission: DELETE_REPOSITORY</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>Handles the DELETE request for removing a software module type from a single distribution set type. Required Permission: DELETE_REPOSITORY</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class=""><td kind="field" title="distributionSetTypeId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">distributionSetTypeId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr><tr class="last "><td kind="field" title="softwareModuleTypeId" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">softwareModuleTypeId</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">integer</span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA iSOCsR" disabled=""><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Distribution Set Type not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Distribution Set Type not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="delete" class="sc-jYnQyy jUYA-DF http-verb delete">delete</span><span class="sc-fYrVWQ gllLir">/rest/v1/distributionsettypes/{distributionSetTypeId}/mandatorymoduletypes/{softwareModuleTypeId}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/distributionsettypes/{distributionSetTypeId}/mandatorymoduletypes/{softwareModuleTypeId}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-594" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-595" tabindex="0" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-595" aria-labelledby="react-tabs-594"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-dQmiwx jCmKdj">application/json</div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"exceptionClass"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errorCode"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"info"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/System-Configuration" data-section-id="tag/System-Configuration" class="sc-eDLKkx hNzKJC"><div class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h1 class="sc-fsYfdN gqLiaw"><a class="sc-csKJxZ fNhImz" href="#tag/System-Configuration" aria-label="tag/System-Configuration"></a>System Configuration</h1></div></div><div class="sc-hLQSwg jSgyLg"><div class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS redoc-markdown " html="<p>REST API for handling tenant specific configuration operations.</p>
|
||
"><p>REST API for handling tenant specific configuration operations.</p>
|
||
</div></div></div><div id="tag/System-Configuration/operation/getTenantConfiguration" data-section-id="tag/System-Configuration/operation/getTenantConfiguration" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getTenantConfiguration" id="operation/getTenantConfiguration" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/System-Configuration/operation/getTenantConfiguration" aria-label="tag/System-Configuration/operation/getTenantConfiguration"></a>Return all tenant specific configuration values<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>The GET request returns a list of all possible configuration keys for the tenant. Required Permission: READ_TENANT_CONFIGURATION</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>The GET request returns a list of all possible configuration keys for the tenant. Required Permission: READ_TENANT_CONFIGURATION</p>
|
||
</div></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/system/configs</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/system/configs</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-596" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-597" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-598" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-599" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-597" aria-labelledby="react-tabs-596"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"property1"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"value"</span>: <span class="token string">""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"global"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/system/configs/authentication.gatewaytoken.key">https://management-api.host.com/rest/v1/system/configs/authentication.gatewaytoken.key</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"property2"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"value"</span>: <span class="token string">""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"global"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/system/configs/authentication.gatewaytoken.key">https://management-api.host.com/rest/v1/system/configs/authentication.gatewaytoken.key</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-599" aria-labelledby="react-tabs-598"></div></div></div></div></div></div><div id="tag/System-Configuration/operation/updateTenantConfiguration" data-section-id="tag/System-Configuration/operation/updateTenantConfiguration" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/updateTenantConfiguration" id="operation/updateTenantConfiguration" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/System-Configuration/operation/updateTenantConfiguration" aria-label="tag/System-Configuration/operation/updateTenantConfiguration"></a>Batch update of tenant configuration.<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>The PUT request updates the whole configuration for the tenant. Required Permission: TENANT_CONFIGURATION</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>The PUT request updates the whole configuration for the tenant. Required Permission: TENANT_CONFIGURATION</p>
|
||
</div></div><h5 class="sc-irLvIq cnGhhy">Request Body schema: <div class="sc-jIBlqr sc-hhyKGa bjIddV lkwvLJ"><svg class="sc-ilxebA bCxWCn" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div><div class="sc-gUjWJS sc-eKzvBH sc-jnlcPO itHPsH ciWJhv gcZOqF">required</div></h5><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"></div><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="additionalProperties" title="property name*" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">property name*</span><div class="sc-gUjWJS sc-eKzvBH sc-ppzwM itHPsH ciWJhv gwpJhW">additional property</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">object</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">409<!-- --> </strong><div html="<p>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.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>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.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">415<!-- --> </strong><div html="<p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="put" class="sc-jYnQyy hyHSPQ http-verb put">put</span><span class="sc-fYrVWQ gllLir">/rest/v1/system/configs</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/system/configs</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Request samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-600" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-601" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-601" aria-labelledby="react-tabs-600"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"property1"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"property2"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-602" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-603" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-604" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-605" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-603" aria-labelledby="react-tabs-602"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"value"</span>: <span class="token string">""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"global"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"_links"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/system/configs/authentication.gatewaytoken.key">https://management-api.host.com/rest/v1/system/configs/authentication.gatewaytoken.key</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-605" aria-labelledby="react-tabs-604"></div></div></div></div></div></div><div id="tag/System-Configuration/operation/getTenantConfigurationValue" data-section-id="tag/System-Configuration/operation/getTenantConfigurationValue" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/getTenantConfigurationValue" id="operation/getTenantConfigurationValue" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/System-Configuration/operation/getTenantConfigurationValue" aria-label="tag/System-Configuration/operation/getTenantConfigurationValue"></a>Return a tenant specific configuration value<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>The GET request returns the configuration value of a specific configuration key for the tenant. Required Permission: READ_TENANT_CONFIGURATION</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>The GET request returns the configuration value of a specific configuration key for the tenant. Required Permission: READ_TENANT_CONFIGURATION</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="keyName" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">keyName</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Configuration key not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Configuration key not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="get" class="sc-jYnQyy eIFDdZ http-verb get">get</span><span class="sc-fYrVWQ gllLir">/rest/v1/system/configs/{keyName}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/system/configs/{keyName}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-606" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-607" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-608" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-609" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-607" aria-labelledby="react-tabs-606"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"global"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/system/configs/authentication.gatewaytoken.key">https://management-api.host.com/rest/v1/system/configs/authentication.gatewaytoken.key</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-609" aria-labelledby="react-tabs-608"></div></div></div></div></div></div><div id="tag/System-Configuration/operation/updateTenantConfigurationValue" data-section-id="tag/System-Configuration/operation/updateTenantConfigurationValue" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/updateTenantConfigurationValue" id="operation/updateTenantConfigurationValue" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/System-Configuration/operation/updateTenantConfigurationValue" aria-label="tag/System-Configuration/operation/updateTenantConfigurationValue"></a>Update a tenant specific configuration value.<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>The PUT request changes a configuration value of a specific configuration key for the tenant. Required Permission: TENANT_CONFIGURATION</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>The PUT request changes a configuration value of a specific configuration key for the tenant. Required Permission: TENANT_CONFIGURATION</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="keyName" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">keyName</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><h5 class="sc-irLvIq cnGhhy">Request Body schema: <div class="sc-jIBlqr sc-hhyKGa bjIddV lkwvLJ"><svg class="sc-ilxebA bCxWCn" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div><div class="sc-gUjWJS sc-eKzvBH sc-jnlcPO itHPsH ciWJhv gcZOqF">required</div></h5><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"></div><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="value" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">value</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">object</span></div> <div><div html="<p>Current value of of configuration parameter</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Current value of of configuration parameter</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA fIqGlH"><svg class="sc-eTNRI hUWsvg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">404<!-- --> </strong><div html="<p>Configuration key not found.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Configuration key not found.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">409<!-- --> </strong><div html="<p>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.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>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.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">415<!-- --> </strong><div html="<p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request was attempt with a media-type which is not supported by the server for this resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="put" class="sc-jYnQyy hyHSPQ http-verb put">put</span><span class="sc-fYrVWQ gllLir">/rest/v1/system/configs/{keyName}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/system/configs/{keyName}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Request samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-610" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-611" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-611" aria-labelledby="react-tabs-610"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">"exampleToken"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-612" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-613" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-614" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-615" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-613" aria-labelledby="react-tabs-612"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-jIBlqr sc-BCDEK bjIddV jyPEvF"><svg class="sc-ilxebA hNiGMc" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/hal+json" selected="">application/hal+json</option><option value="application/json">application/json</option></select><label>application/hal+json</label></div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"global"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"self"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"href"</span>: <span class="token string">"</span><a href="https://management-api.host.com/rest/v1/system/configs/authentication.gatewaytoken.key">https://management-api.host.com/rest/v1/system/configs/authentication.gatewaytoken.key</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-615" aria-labelledby="react-tabs-614"></div></div></div></div></div></div><div id="tag/System-Configuration/operation/deleteTenantConfigurationValue" data-section-id="tag/System-Configuration/operation/deleteTenantConfigurationValue" class="sc-eDLKkx cSNAXN"><div data-section-id="operation/deleteTenantConfigurationValue" id="operation/deleteTenantConfigurationValue" class="sc-iBdnpw fsPUig"><div class="sc-hLQSwg gikxZY"><h2 class="sc-qZrbh gwJLUj"><a class="sc-csKJxZ fNhImz" href="#tag/System-Configuration/operation/deleteTenantConfigurationValue" aria-label="tag/System-Configuration/operation/deleteTenantConfigurationValue"></a>Delete a tenant specific configuration value<!-- --> </h2><div class="sc-eYFTNc dZbpPF"><div html="<p>The DELETE request removes a tenant specific configuration value for the tenant. Afterwards the global default value is used. Required Permission: TENANT_CONFIGURATION</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS"><p>The DELETE request removes a tenant specific configuration value for the tenant. Afterwards the global default value is used. Required Permission: TENANT_CONFIGURATION</p>
|
||
</div></div><div><h5 class="sc-irLvIq cnGhhy">path<!-- --> Parameters</h5><table class="sc-hIPBNq kHkWhD"><tbody><tr class="last "><td kind="field" title="keyName" class="sc-hABBmJ sc-fHejqy cqoAxn hfWKVF"><span class="sc-ifyrAs hIHfpT"></span><span class="property-name">keyName</span><div class="sc-gUjWJS sc-eKzvBH itHPsH ciWJhv">required</div></td><td class="sc-blmEgr berbbf"><div><div><span class="sc-gUjWJS sc-kZOsHZ itHPsH iSyacY"></span><span class="sc-gUjWJS sc-iLXxbI itHPsH gfdSsP">string</span></div> <div><div html="" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fYitVF duKVDl">Responses</h3><div><button class="sc-hsaIUA iSOCsR" disabled=""><strong class="sc-gWQvRS ePkkgX">200<!-- --> </strong><div html="<p>Successfully retrieved</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Successfully retrieved</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ideQht"><svg class="sc-eTNRI fWTllA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-gWQvRS ePkkgX">400<!-- --> </strong><div html="<p>Bad Request - e.g. invalid parameters</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Bad Request - e.g. invalid parameters</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">401<!-- --> </strong><div html="<p>The request requires user authentication.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The request requires user authentication.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">403<!-- --> </strong><div html="<p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">405<!-- --> </strong><div html="<p>The http request method is not allowed on the resource.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>The http request method is not allowed on the resource.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">406<!-- --> </strong><div html="<p>In case accept header is specified and not application/json.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>In case accept header is specified and not application/json.</p>
|
||
</div></button></div><div><button class="sc-hsaIUA ifZPCr" disabled=""><strong class="sc-gWQvRS ePkkgX">429<!-- --> </strong><div html="<p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk"><p>Too many requests. The server will refuse further attempts and the client has to wait another second.</p>
|
||
</div></button></div></div></div><div class="sc-jTQCzO sc-gLLuof imiXRU jGdkPR"><div class="sc-bPrlCs cIsduN"><button class="sc-GkLId bclCVA"><span type="delete" class="sc-jYnQyy jUYA-DF http-verb delete">delete</span><span class="sc-fYrVWQ gllLir">/rest/v1/system/configs/{keyName}</span><svg class="sc-eTNRI exoGJA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eGgGjL hsEiws"><div class="sc-fnpiog jerStl"><div html="<p>Generated server url</p>
|
||
" class="sc-iKOmoZ sc-cCzLxZ WVNwY jaVotg"><p>Generated server url</p>
|
||
</div><div tabindex="0" role="button"><div class="sc-lkDHyp etvaCd"><span>http://localhost:53002</span>/rest/v1/system/configs/{keyName}</div></div></div></div></div><div><h3 class="sc-kFCroH klfnyk"> <!-- -->Response samples<!-- --> </h3><div class="sc-cyZbeP jSWvqu" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-616" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-617" tabindex="0" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-617" aria-labelledby="react-tabs-616"><div><div class="sc-cPtzlb jBjImi"><span class="sc-bCvmQg eTZsJr">Content type</span><div class="sc-dQmiwx jCmKdj">application/json</div></div><div class="sc-hVcFVo jeLSWq"><div class="sc-cSxRuM fOJBdW"><div class="sc-gjLLEI iwAAMv"><button><div class="sc-jdHILj krcPXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmoZ WVNwY sc-jMbVJB DqFKH"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"exceptionClass"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errorCode"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"info"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div></div><div class="sc-juusvx bsunyy"></div></div></div>
|
||
<script>
|
||
const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.0.1","info":{"title":"hawkBit REST APIs","description":"Eclipse hawkBit™ is a domain-independent back-end framework for rolling out software updates to constrained edge devices as well as more powerful controllers and gateways connected to IP based networking infrastructure.\n","version":"v1"},"servers":[{"url":"http://localhost:53002","description":"Generated server url"}],"tags":[{"name":"Distribution Sets","description":"REST Resource handling for DistributionSet CRUD operations."},{"name":"Targets","description":"REST API for Target CRUD operations."},{"name":"Actions","description":"REST API providing (read-only) access to actions."},{"name":"Basic Authentication","description":"API for basic auth user validation."},{"name":"Software Module Types","description":"REST API for SoftwareModuleTypes CRUD operations."},{"name":"Rollouts","description":"REST API for Rollout CRUD operations."},{"name":"Target Types","description":"REST API for Target Type CRUD operations."},{"name":"Software Modules","description":"REST API for SoftwareModule and related Artifact CRUD operations."},{"name":"Target Tags","description":"REST API for Target Tag CRUD operations."},{"name":"Target Filter Queries","description":"REST API for Target Filter Queries CRUD operations."},{"name":"Download artifact","description":"API to download artifacts."},{"name":"Distribution Set Tags","description":"REST Resource handling for DistributionSetTag CRUD operations."},{"name":"Distribution Set Types","description":"REST Resource handling for DistributionSetType CRUD operations."},{"name":"System Configuration","description":"REST API for handling tenant specific configuration operations."}],"paths":{"/rest/v1/targettypes/{targetTypeId}":{"get":{"tags":["Target Types"],"summary":"Return target type by id","description":"Handles the GET request of retrieving a single target type","operationId":"getTargetType","parameters":[{"name":"targetTypeId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtTargetType"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtTargetType"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Target type not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}},"put":{"tags":["Target Types"],"summary":"Update target type by id","description":"Handles the PUT request for a single target type. Required Permission: UPDATE_TARGET","operationId":"updateTargetType","parameters":[{"name":"targetTypeId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtTargetTypeRequestBodyPut"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtTargetTypeRequestBodyPut"}}},"required":true},"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtTargetType"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtTargetType"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Target type not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"409":{"description":"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.","content":{"application/json":{}}},"415":{"description":"The request was attempt with a media-type which is not supported by the server for this resource.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}},"delete":{"tags":["Target Types"],"summary":"Delete target type by id","description":"Handles the DELETE request for a single target type. Required Permission: DELETE_TARGET","operationId":"deleteTargetType","parameters":[{"name":"targetTypeId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successfully retrieved"},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Target type not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/targettags/{targetTagId}":{"get":{"tags":["Target Tags"],"summary":"Return target tag by id","description":"Handles the GET request of retrieving a single target tag.","operationId":"getTargetTag","parameters":[{"name":"targetTagId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtTag"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtTag"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtTag"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtTag"}}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtTag"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtTag"}}}},"404":{"description":"Target tag not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtTag"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtTag"}}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtTag"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtTag"}}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtTag"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtTag"}}}}}},"put":{"tags":["Target Tags"],"summary":"Update target tag by id","description":"Handles the PUT request of updating a target tag.","operationId":"updateTargetTag","parameters":[{"name":"targetTagId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtTagRequestBodyPut"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtTagRequestBodyPut"}}},"required":true},"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtTag"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtTag"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtTag"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtTag"}}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtTag"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtTag"}}}},"404":{"description":"Target tag not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtTag"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtTag"}}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtTag"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtTag"}}}},"409":{"description":"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.","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtTag"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtTag"}}}},"415":{"description":"The request was attempt with a media-type which is not supported by the server for this resource.","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtTag"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtTag"}}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtTag"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtTag"}}}}}},"delete":{"tags":["Target Tags"],"summary":"Delete target tag by id","description":"Handles the DELETE request of deleting a single target tag.","operationId":"deleteTargetTag","parameters":[{"name":"targetTagId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successfully retrieved"},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication."},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies."},"404":{"description":"Target tag not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource."},"406":{"description":"In case accept header is specified and not application/json."},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second."}}}},"/rest/v1/targettags/{targetTagId}/assigned":{"get":{"tags":["Target Tags"],"summary":"Return assigned targets for tag","description":"Handles the GET request of retrieving a list of assigned targets.","operationId":"getAssignedTargets","parameters":[{"name":"targetTagId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"offset","in":"query","description":"The paging offset (default is 0)","required":false,"schema":{"type":"integer","description":"The paging offset (default is 0)","format":"int32","default":0}},{"name":"limit","in":"query","description":"The maximum number of entries in a page (default is 50)","required":false,"schema":{"type":"integer","description":"The maximum number of entries in a page (default is 50)","format":"int32","default":50}},{"name":"sort","in":"query","description":"The query parameter sort allows to define the sort order for the result of a query. A sort criteria\nconsists of the name of a field and the sort direction (ASC for ascending and DESC descending).\nThe sequence of the sort criteria (multiple can be used) defines the sort order of the entities\nin the result.","required":false,"schema":{"type":"string","description":"The query parameter sort allows to define the sort order for the result of a query. A sort criteria\nconsists of the name of a field and the sort direction (ASC for ascending and DESC descending).\nThe sequence of the sort criteria (multiple can be used) defines the sort order of the entities\nin the result."}},{"name":"q","in":"query","description":"Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for\navailable fields.","required":false,"schema":{"type":"string","description":"Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for\navailable fields."}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtTarget"}},"application/json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtTarget"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtTarget"}},"application/json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtTarget"}}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtTarget"}},"application/json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtTarget"}}}},"404":{"description":"Target tag not found","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtTarget"}},"application/json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtTarget"}}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtTarget"}},"application/json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtTarget"}}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtTarget"}},"application/json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtTarget"}}}}}},"put":{"tags":["Target Tags"],"summary":"Assign target(s) to given tagId","description":"Handles the POST request of target assignment. Already assigned target will be ignored.","operationId":"assignTargets","parameters":[{"name":"targetTagId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"onNotFoundPolicy","in":"query","required":false,"schema":{"type":"string","default":"FAIL","enum":["FAIL","ON_WHAT_FOUND_AND_FAIL","ON_WHAT_FOUND_AND_SUCCESS"]}}],"requestBody":{"content":{"application/hal+json":{"schema":{"type":"array","description":"List of controller ids to be assigned","example":["controllerId1","controllerId2"],"items":{"type":"string","description":"List of controller ids to be assigned","example":"[\"controllerId1\",\"controllerId2\"]"}}},"application/json":{"schema":{"type":"array","description":"List of controller ids to be assigned","example":["controllerId1","controllerId2"],"items":{"type":"string","description":"List of controller ids to be assigned","example":"[\"controllerId1\",\"controllerId2\"]"}}}},"required":true},"responses":{"200":{"description":"Successfully assigned"},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication."},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies."},"404":{"description":"Not Found - e.g. target tag not found. Contains info about not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"405":{"description":"The http request method is not allowed on the resource."},"406":{"description":"In case accept header is specified and not application/json."},"409":{"description":"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."},"415":{"description":"The request was attempt with a media-type which is not supported by the server for this resource."},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second."}}},"delete":{"tags":["Target Tags"],"summary":"Unassign targets from a given tagId","description":"Handles the DELETE request to unassign the given targets.","operationId":"unassignTargets","parameters":[{"name":"targetTagId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"onNotFoundPolicy","in":"query","required":false,"schema":{"type":"string","default":"FAIL","enum":["FAIL","ON_WHAT_FOUND_AND_FAIL","ON_WHAT_FOUND_AND_SUCCESS"]}}],"requestBody":{"content":{"application/hal+json":{"schema":{"type":"array","description":"List of controller ids to be unassigned","example":["controllerId1","controllerId2"],"items":{"type":"string","description":"List of controller ids to be unassigned","example":"[\"controllerId1\",\"controllerId2\"]"}}},"application/json":{"schema":{"type":"array","description":"List of controller ids to be unassigned","example":["controllerId1","controllerId2"],"items":{"type":"string","description":"List of controller ids to be unassigned","example":"[\"controllerId1\",\"controllerId2\"]"}}}},"required":true},"responses":{"200":{"description":"Successfully retrieved"},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication."},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies."},"404":{"description":"Not Found - e.g. target tag not found. Contains info about not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"405":{"description":"The http request method is not allowed on the resource."},"406":{"description":"In case accept header is specified and not application/json."},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second."}}}},"/rest/v1/targets/{targetId}":{"get":{"tags":["Targets"],"summary":"Return target by id","description":"Handles the GET request of retrieving a single target. Required Permission: READ_TARGET.","operationId":"getTarget","parameters":[{"name":"targetId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtTarget"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtTarget"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Target not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}},"put":{"tags":["Targets"],"summary":"Update target by id","description":"Handles the PUT request of updating a target. Required Permission: UPDATE_TARGET","operationId":"updateTarget","parameters":[{"name":"targetId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtTargetRequestBody"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtTargetRequestBody"}}},"required":true},"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtTarget"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtTarget"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Target not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"409":{"description":"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.","content":{"application/json":{}}},"415":{"description":"The request was attempt with a media-type which is not supported by the server for this resource.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}},"delete":{"tags":["Targets"],"summary":"Delete target by id","description":"Handles the DELETE request of deleting a single target. Required Permission: DELETE_TARGET","operationId":"deleteTarget","parameters":[{"name":"targetId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved"},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Target not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/targets/{targetId}/metadata/{metadataKey}":{"get":{"tags":["Targets"],"summary":"Return single metadata value for a specific key of a target","description":"Get a single metadata value for a metadata key. Required permission: READ_REPOSITORY","operationId":"getMetadataValue","parameters":[{"name":"targetId","in":"path","required":true,"schema":{"type":"string"}},{"name":"metadataKey","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MgmtMetadata"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Target not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}},"put":{"tags":["Targets"],"summary":"Updates a single metadata value of a target","description":"Update a single metadata value for speficic key. Required permission: UPDATE_REPOSITORY","operationId":"updateMetadata","parameters":[{"name":"targetId","in":"path","required":true,"schema":{"type":"string"}},{"name":"metadataKey","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MgmtMetadataBodyPut"}}},"required":true},"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtMetadata"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtMetadata"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Target not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"409":{"description":"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.","content":{"application/json":{}}},"415":{"description":"The request was attempt with a media-type which is not supported by the server for this resource.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}},"delete":{"tags":["Targets"],"summary":"Deletes a single metadata entry from a target","description":"Delete a single metadata. Required permission: UPDATE_REPOSITORY","operationId":"deleteMetadata","parameters":[{"name":"targetId","in":"path","required":true,"schema":{"type":"string"}},{"name":"metadataKey","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved"},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Target not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/targets/{targetId}/actions/{actionId}":{"get":{"tags":["Targets"],"summary":"Return action by id of a specific target","description":"Handles the GET request of retrieving a specific action on a specific target. Required Permission: READ_TARGET","operationId":"getAction","parameters":[{"name":"targetId","in":"path","required":true,"schema":{"type":"string"}},{"name":"actionId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtAction"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtAction"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Target not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}},"put":{"tags":["Targets"],"summary":"Switch an action from soft to forced","description":"Handles the PUT request to switch an action from soft to forced. Required Permission: UPDATE_TARGET.","operationId":"updateAction","parameters":[{"name":"targetId","in":"path","required":true,"schema":{"type":"string"}},{"name":"actionId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtActionRequestBodyPut"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtActionRequestBodyPut"}}},"required":true},"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtAction"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtAction"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Target not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"409":{"description":"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.","content":{"application/json":{}}},"415":{"description":"The request was attempt with a media-type which is not supported by the server for this resource.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}},"delete":{"tags":["Targets"],"summary":"Cancel action for a specific target","description":"Cancels an active action, only active actions can be deleted. Required Permission: UPDATE_TARGET","operationId":"cancelAction","parameters":[{"name":"targetId","in":"path","required":true,"schema":{"type":"string"}},{"name":"actionId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"force","in":"query","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Successfully retrieved"},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Target not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/targets/{targetId}/actions/{actionId}/confirmation":{"put":{"tags":["Targets"],"summary":"Controls (confirm/deny) actions waiting for confirmation","description":"Either confirm or deny an action which is waiting for confirmation.\nThe action will be transferred into the RUNNING state in case confirming it.\nThe action will remain in WAITING_FOR_CONFIRMATION state in case denying it.\nRequired Permission: READ_REPOSITORY AND UPDATE_TARGET\n","operationId":"updateActionConfirmation","parameters":[{"name":"targetId","in":"path","required":true,"schema":{"type":"string"}},{"name":"actionId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtActionConfirmationRequestBodyPut"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtActionConfirmationRequestBodyPut"}}},"required":true},"responses":{"200":{"description":"Successfully updated confirmation status of the action"},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Target or Action not found","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"409":{"description":"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.","content":{"application/json":{}}},"410":{"description":"Action is not active anymore.","content":{"application/json":{}}},"415":{"description":"The request was attempt with a media-type which is not supported by the server for this resource.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/targetfilters/{filterId}":{"get":{"tags":["Target Filter Queries"],"summary":"Return target filter query by id","description":"Handles the GET request of retrieving a single target filter query. Required permission: READ_TARGET","operationId":"getFilter","parameters":[{"name":"filterId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtTargetFilterQuery"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtTargetFilterQuery"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Target filter query not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}},"put":{"tags":["Target Filter Queries"],"summary":"Updates target filter query by id","description":"Handles the PUT request of updating a target filter query. Required permission: UPDATE_TARGET","operationId":"updateFilter","parameters":[{"name":"filterId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtTargetFilterQueryRequestBody"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtTargetFilterQueryRequestBody"}}},"required":true},"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtTargetFilterQuery"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtTargetFilterQuery"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Target filter query not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"409":{"description":"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.","content":{"application/json":{}}},"415":{"description":"The request was attempt with a media-type which is not supported by the server for this resource.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}},"delete":{"tags":["Target Filter Queries"],"summary":"Delete target filter by id","description":"Handles the DELETE request of deleting a target filter query. Required permission: DELETE_TARGET","operationId":"deleteFilter","parameters":[{"name":"filterId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successfully retrieved"},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Target filter query not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/system/configs":{"get":{"tags":["System Configuration"],"summary":"Return all tenant specific configuration values","description":"The GET request returns a list of all possible configuration keys for the tenant. Required Permission: READ_TENANT_CONFIGURATION","operationId":"getTenantConfiguration","responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/MgmtSystemTenantConfigurationValue"}}},"application/json":{"schema":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/MgmtSystemTenantConfigurationValue"}}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}},"put":{"tags":["System Configuration"],"summary":"Batch update of tenant configuration.","description":"The PUT request updates the whole configuration for the tenant. Required Permission: TENANT_CONFIGURATION","operationId":"updateTenantConfiguration","requestBody":{"content":{"application/hal+json":{"schema":{"type":"object","additionalProperties":{"type":"object"}}},"application/json":{"schema":{"type":"object","additionalProperties":{"type":"object"}}}},"required":true},"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtSystemTenantConfigurationValue"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtSystemTenantConfigurationValue"}}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"409":{"description":"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.","content":{"application/json":{}}},"415":{"description":"The request was attempt with a media-type which is not supported by the server for this resource.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/system/configs/{keyName}":{"get":{"tags":["System Configuration"],"summary":"Return a tenant specific configuration value","description":"The GET request returns the configuration value of a specific configuration key for the tenant. Required Permission: READ_TENANT_CONFIGURATION","operationId":"getTenantConfigurationValue","parameters":[{"name":"keyName","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtSystemTenantConfigurationValue"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtSystemTenantConfigurationValue"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Configuration key not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}},"put":{"tags":["System Configuration"],"summary":"Update a tenant specific configuration value.","description":"The PUT request changes a configuration value of a specific configuration key for the tenant. Required Permission: TENANT_CONFIGURATION","operationId":"updateTenantConfigurationValue","parameters":[{"name":"keyName","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtSystemTenantConfigurationValueRequest"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtSystemTenantConfigurationValueRequest"}}},"required":true},"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtSystemTenantConfigurationValue"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtSystemTenantConfigurationValue"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Configuration key not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"409":{"description":"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.","content":{"application/json":{}}},"415":{"description":"The request was attempt with a media-type which is not supported by the server for this resource.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}},"delete":{"tags":["System Configuration"],"summary":"Delete a tenant specific configuration value","description":"The DELETE request removes a tenant specific configuration value for the tenant. Afterwards the global default value is used. Required Permission: TENANT_CONFIGURATION","operationId":"deleteTenantConfigurationValue","parameters":[{"name":"keyName","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved"},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/softwaremoduletypes/{softwareModuleTypeId}":{"get":{"tags":["Software Module Types"],"summary":"Return single Software Module Type","description":"Handles the GET request of retrieving a single software module type. Required Permission: READ_REPOSITORY","operationId":"getSoftwareModuleType","parameters":[{"name":"softwareModuleTypeId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtSoftwareModuleType"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtSoftwareModuleType"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Software Module Type not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}},"put":{"tags":["Software Module Types"],"summary":"Update Software Module Type","description":"Handles the PUT request for a single software module type. Required Permission: UPDATE_REPOSITORY","operationId":"updateSoftwareModuleType","parameters":[{"name":"softwareModuleTypeId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtSoftwareModuleTypeRequestBodyPut"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtSoftwareModuleTypeRequestBodyPut"}}},"required":true},"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtSoftwareModuleType"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtSoftwareModuleType"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Software Module Type not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"409":{"description":"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.","content":{"application/json":{}}},"415":{"description":"The request was attempt with a media-type which is not supported by the server for this resource.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}},"delete":{"tags":["Software Module Types"],"summary":"Delete Software Module Type by Id","description":"Handles the DELETE request for a single software module type. Required Permission: DELETE_REPOSITORY","operationId":"deleteSoftwareModuleType","parameters":[{"name":"softwareModuleTypeId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successfully retrieved"},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Software Module Type not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/softwaremodules/{softwareModuleId}":{"get":{"tags":["Software Modules"],"summary":"Return Software Module by id","description":"Handles the GET request of retrieving a single softwaremodule. Required Permission: READ_REPOSITORY","operationId":"getSoftwareModule","parameters":[{"name":"softwareModuleId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtSoftwareModule"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtSoftwareModule"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Software Module not found ","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}},"put":{"tags":["Software Modules"],"summary":"Update Software Module","description":"Handles the PUT request for a single softwaremodule within Hawkbit. Required Permission: UPDATE_REPOSITORY","operationId":"updateSoftwareModule","parameters":[{"name":"softwareModuleId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtSoftwareModuleRequestBodyPut"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtSoftwareModuleRequestBodyPut"}}},"required":true},"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtSoftwareModule"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtSoftwareModule"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Software Module not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"409":{"description":"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.","content":{"application/json":{}}},"415":{"description":"The request was attempt with a media-type which is not supported by the server for this resource.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}},"delete":{"tags":["Software Modules"],"summary":"Delete Software Module by Id","description":"Handles the DELETE request for a single softwaremodule within Hawkbit. Required Permission: DELETE_REPOSITORY","operationId":"deleteSoftwareModule","parameters":[{"name":"softwareModuleId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successfully retrieved"},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Software Module not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/softwaremodules/{softwareModuleId}/metadata/{metadataKey}":{"get":{"tags":["Software Modules"],"summary":"Return single metadata value for a specific key of a Software Module","description":"Get a single metadata value for a metadata key. Required Permission: READ_REPOSITORY","operationId":"getMetadataValue_1","parameters":[{"name":"softwareModuleId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"metadataKey","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtSoftwareModuleMetadata"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtSoftwareModuleMetadata"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Software Module not found ","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}},"put":{"tags":["Software Modules"],"summary":"Update a single metadata value of a Software Module","description":"Update a single metadata value for speficic key. Required Permission: UPDATE_REPOSITORY","operationId":"updateMetadata_1","parameters":[{"name":"softwareModuleId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"metadataKey","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MgmtSoftwareModuleMetadataBodyPut"}}},"required":true},"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtSoftwareModuleMetadata"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtSoftwareModuleMetadata"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Software Module not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}},"delete":{"tags":["Software Modules"],"summary":"Delete single metadata entry from the software module","description":"Delete a single metadata. Required Permission: UPDATE_REPOSITORY","operationId":"deleteMetadata_1","parameters":[{"name":"softwareModuleId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"metadataKey","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved"},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Software Module not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/rollouts/{rolloutId}":{"get":{"tags":["Rollouts"],"summary":"Return single Rollout","description":"Handles the GET request of retrieving a single rollout. Required Permission: READ_ROLLOUT","operationId":"getRollout","parameters":[{"name":"rolloutId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtRolloutResponseBody"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtRolloutResponseBody"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Rollout not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}},"put":{"tags":["Rollouts"],"summary":"Update Rollout","description":"Handles the UPDATE request for a single Rollout. Required permission: UPDATE_ROLLOUT","operationId":"update","parameters":[{"name":"rolloutId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtRolloutRestRequestBodyPut"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtRolloutRestRequestBodyPut"}}},"required":true},"responses":{"200":{"description":"Successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MgmtRolloutResponseBody"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtRolloutResponseBody"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Distribution Set not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"409":{"description":"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.","content":{"application/json":{}}},"415":{"description":"The request was attempt with a media-type which is not supported by the server for this resource.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}},"delete":{"tags":["Rollouts"],"summary":"Delete a Rollout","description":"Handles the DELETE request of deleting a rollout. Required Permission: DELETE_ROLLOUT","operationId":"delete","parameters":[{"name":"rolloutId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successfully retrieved"},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Rollout not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/distributionsettypes/{distributionSetTypeId}":{"get":{"tags":["Distribution Set Types"],"summary":"Return single Distribution Set Type","description":"Handles the GET request of retrieving a single distribution set type. Required Permission: READ_REPOSITORY","operationId":"getDistributionSetType","parameters":[{"name":"distributionSetTypeId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtDistributionSetType"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtDistributionSetType"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Distribution Set Type not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}},"put":{"tags":["Distribution Set Types"],"summary":"Update Distribution Set Type","description":"Handles the PUT request for a single distribution set type. Required Permission: UPDATE_REPOSITORY","operationId":"updateDistributionSetType","parameters":[{"name":"distributionSetTypeId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtDistributionSetTypeRequestBodyPut"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtDistributionSetTypeRequestBodyPut"}}},"required":true},"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtDistributionSetType"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtDistributionSetType"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Distribution Set Type not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"409":{"description":"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.","content":{"application/json":{}}},"415":{"description":"The request was attempt with a media-type which is not supported by the server for this resource.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}},"delete":{"tags":["Distribution Set Types"],"summary":"Delete Distribution Set Type by Id","description":"Handles the DELETE request for a single distribution set type. Required Permission: DELETE_REPOSITORY","operationId":"deleteDistributionSetType","parameters":[{"name":"distributionSetTypeId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successfully retrieved"},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Distribution Set Type not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/distributionsettags/{distributionsetTagId}":{"get":{"tags":["Distribution Set Tags"],"summary":"Return single Distribution Set Tag","description":"Handles the GET request of retrieving a single distribution set tag.","operationId":"getDistributionSetTag","parameters":[{"name":"distributionsetTagId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtTag"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtTag"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Distribution Set Tag not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}},"put":{"tags":["Distribution Set Tags"],"summary":"Update Distribution Set Tag","description":"Handles the PUT request of updating a distribution set tag.","operationId":"updateDistributionSetTag","parameters":[{"name":"distributionsetTagId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtTagRequestBodyPut"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtTagRequestBodyPut"}}},"required":true},"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtTag"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtTag"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Distribution Set Tag not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"409":{"description":"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.","content":{"application/json":{}}},"415":{"description":"The request was attempt with a media-type which is not supported by the server for this resource.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}},"delete":{"tags":["Distribution Set Tags"],"summary":"Delete a single distribution set tag","description":"Handles the DELETE request of deleting a single distribution set tag.","operationId":"deleteDistributionSetTag","parameters":[{"name":"distributionsetTagId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successfully retrieved"},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Distribution Set Tag not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"409":{"description":"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.","content":{"application/json":{}}},"415":{"description":"The request was attempt with a media-type which is not supported by the server for this resource.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/distributionsettags/{distributionsetTagId}/assigned":{"get":{"tags":["Distribution Set Tags"],"summary":"Return all assigned distribution sets by given tag Id","description":"Handles the GET request of retrieving a list of assigned distributions.","operationId":"getAssignedDistributionSets","parameters":[{"name":"distributionsetTagId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"offset","in":"query","description":"The paging offset (default is 0)","required":false,"schema":{"type":"integer","description":"The paging offset (default is 0)","format":"int32","default":0}},{"name":"limit","in":"query","description":"The maximum number of entries in a page (default is 50)","required":false,"schema":{"type":"integer","description":"The maximum number of entries in a page (default is 50)","format":"int32","default":50}},{"name":"sort","in":"query","description":"The query parameter sort allows to define the sort order for the result of a query. A sort criteria\nconsists of the name of a field and the sort direction (ASC for ascending and DESC descending).\nThe sequence of the sort criteria (multiple can be used) defines the sort order of the entities\nin the result.","required":false,"schema":{"type":"string","description":"The query parameter sort allows to define the sort order for the result of a query. A sort criteria\nconsists of the name of a field and the sort direction (ASC for ascending and DESC descending).\nThe sequence of the sort criteria (multiple can be used) defines the sort order of the entities\nin the result."}},{"name":"q","in":"query","description":"Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for\navailable fields.","required":false,"schema":{"type":"string","description":"Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for\navailable fields."}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtDistributionSet"}},"application/json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtDistributionSet"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Distribution Set Tag not found","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}},"put":{"tags":["Distribution Set Tags"],"operationId":"assignDistributionSetsPut","parameters":[{"name":"distributionsetTagId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/hal+json":{"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},"application/json":{"schema":{"type":"array","items":{"type":"integer","format":"int64"}}}},"required":true},"responses":{"200":{"description":"OK"}}},"post":{"tags":["Distribution Set Tags"],"summary":"Assign distribution sets to the given tag id","description":"Handles the POST request of distribution assignment. Already assigned distribution will be ignored.","operationId":"assignDistributionSets","parameters":[{"name":"distributionsetTagId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/hal+json":{"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},"application/json":{"schema":{"type":"array","items":{"type":"integer","format":"int64"}}}},"required":true},"responses":{"200":{"description":"Successfully retrieved"},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Not Found - e.g. a distribution set or tags are not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"409":{"description":"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.","content":{"application/json":{}}},"415":{"description":"The request was attempt with a media-type which is not supported by the server for this resource.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}},"delete":{"tags":["Distribution Set Tags"],"summary":"Unassign multiple distribution sets from the given tag id","description":"Handles the DELETE request of unassign the given distribution.","operationId":"unassignDistributionSets","parameters":[{"name":"distributionsetTagId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"integer","format":"int64"}}}},"required":true},"responses":{"200":{"description":"Successfully retrieved"},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Not Found - e.g. a distribution set or tags are not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/distributionsets/{distributionSetId}":{"get":{"tags":["Distribution Sets"],"summary":"Return single Distribution Set","description":"Handles the GET request of retrieving a single distribution set. Required permission: READ_REPOSITORY","operationId":"getDistributionSet","parameters":[{"name":"distributionSetId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtDistributionSet"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtDistributionSet"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Distribution Set not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}},"put":{"tags":["Distribution Sets"],"summary":"Update Distribution Set","description":"Handles the UPDATE request for a single Distribution Set. Required permission: UPDATE_REPOSITORY","operationId":"updateDistributionSet","parameters":[{"name":"distributionSetId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtDistributionSetRequestBodyPut"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtDistributionSetRequestBodyPut"}}},"required":true},"responses":{"200":{"description":"Successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MgmtDistributionSet"}},"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtDistributionSet"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Distribution Set not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"409":{"description":"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.","content":{"application/json":{}}},"415":{"description":"The request was attempt with a media-type which is not supported by the server for this resource.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}},"delete":{"tags":["Distribution Sets"],"summary":"Delete Distribution Set by Id","description":"Handles the DELETE request for a single Distribution Set. Required permission: DELETE_REPOSITORY","operationId":"deleteDistributionSet","parameters":[{"name":"distributionSetId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successfully retrieved"},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Distribution Set not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/distributionsets/{distributionSetId}/metadata/{metadataKey}":{"get":{"tags":["Distribution Sets"],"summary":"Return single meta data value for a specific key of a Distribution Set","description":"Get a single meta data value for a meta data key. Required permission: READ_REPOSITORY","operationId":"getMetadataValue_2","parameters":[{"name":"distributionSetId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"metadataKey","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MgmtMetadata"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Distribution Set not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}},"put":{"tags":["Distribution Sets"],"summary":"Update single meta data value of a distribution set","description":"Update a single meta data value for speficic key. Required permission: UPDATE_REPOSITORY","operationId":"updateMetadata_2","parameters":[{"name":"distributionSetId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"metadataKey","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MgmtMetadataBodyPut"}}},"required":true},"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtMetadata"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtMetadata"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Distribution Set not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"409":{"description":"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.","content":{"application/json":{}}},"415":{"description":"The request was attempt with a media-type which is not supported by the server for this resource.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}},"delete":{"tags":["Distribution Sets"],"summary":"Delete a single meta data entry from the distribution set","description":"Delete a single meta data. Required permission: UPDATE_REPOSITORY","operationId":"deleteMetadata_2","parameters":[{"name":"distributionSetId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"metadataKey","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved"},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Distribution Set not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/targettypes":{"get":{"tags":["Target Types"],"summary":"Return all target types","description":"Handles the GET request of retrieving all target types.","operationId":"getTargetTypes","parameters":[{"name":"offset","in":"query","description":"The paging offset (default is 0)","required":false,"schema":{"type":"integer","description":"The paging offset (default is 0)","format":"int32","default":0}},{"name":"limit","in":"query","description":"The maximum number of entries in a page (default is 50)","required":false,"schema":{"type":"integer","description":"The maximum number of entries in a page (default is 50)","format":"int32","default":50}},{"name":"sort","in":"query","description":"The query parameter sort allows to define the sort order for the result of a query. A sort criteria\nconsists of the name of a field and the sort direction (ASC for ascending and DESC descending).\nThe sequence of the sort criteria (multiple can be used) defines the sort order of the entities\nin the result.","required":false,"schema":{"type":"string","description":"The query parameter sort allows to define the sort order for the result of a query. A sort criteria\nconsists of the name of a field and the sort direction (ASC for ascending and DESC descending).\nThe sequence of the sort criteria (multiple can be used) defines the sort order of the entities\nin the result."}},{"name":"q","in":"query","description":"Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for\navailable fields.","required":false,"schema":{"type":"string","description":"Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for\navailable fields."}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtTargetType"}},"application/json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtTargetType"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}},"post":{"tags":["Target Types"],"summary":"Create target types","description":"Handles the POST request for creating new target types. The request body must always be a list of types. Required Permission: CREATE_TARGET","operationId":"createTargetTypes","requestBody":{"content":{"application/hal+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtTargetTypeRequestBodyPost"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtTargetTypeRequestBodyPost"}}}},"required":true},"responses":{"201":{"description":"Successfully created","content":{"application/hal+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtTargetType"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtTargetType"}}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Target type not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"409":{"description":"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.","content":{"application/json":{}}},"415":{"description":"The request was attempt with a media-type which is not supported by the server for this resource.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/targettypes/{targetTypeId}/compatibledistributionsettypes":{"get":{"tags":["Target Types"],"summary":"Return list of compatible distribution set types","description":"Handles the GET request of retrieving the list of compatible distribution set types in that target type. Required Permission: READ_TARGET, READ_REPOSITORY","operationId":"getCompatibleDistributionSets","parameters":[{"name":"targetTypeId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtDistributionSetType"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtDistributionSetType"}}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Distribution set type was not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}},"post":{"tags":["Target Types"],"summary":"Adding compatibility of a distribution set type to a target type","description":"Handles the POST request for adding compatible distribution set types to a target type. Required Permission: UPDATE_TARGET and READ_REPOSITORY","operationId":"addCompatibleDistributionSets","parameters":[{"name":"targetTypeId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/hal+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtDistributionSetTypeAssignment"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtDistributionSetTypeAssignment"}}}},"required":true},"responses":{"200":{"description":"Successfully retrieved"},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Distribution set type was not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"409":{"description":"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.","content":{"application/json":{}}},"415":{"description":"The request was attempt with a media-type which is not supported by the server for this resource.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/targettags":{"get":{"tags":["Target Tags"],"summary":"Return all target tags","description":"Handles the GET request of retrieving all target tags.","operationId":"getTargetTags","parameters":[{"name":"offset","in":"query","description":"The paging offset (default is 0)","required":false,"schema":{"type":"integer","description":"The paging offset (default is 0)","format":"int32","default":0}},{"name":"limit","in":"query","description":"The maximum number of entries in a page (default is 50)","required":false,"schema":{"type":"integer","description":"The maximum number of entries in a page (default is 50)","format":"int32","default":50}},{"name":"sort","in":"query","description":"The query parameter sort allows to define the sort order for the result of a query. A sort criteria\nconsists of the name of a field and the sort direction (ASC for ascending and DESC descending).\nThe sequence of the sort criteria (multiple can be used) defines the sort order of the entities\nin the result.","required":false,"schema":{"type":"string","description":"The query parameter sort allows to define the sort order for the result of a query. A sort criteria\nconsists of the name of a field and the sort direction (ASC for ascending and DESC descending).\nThe sequence of the sort criteria (multiple can be used) defines the sort order of the entities\nin the result."}},{"name":"q","in":"query","description":"Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for\navailable fields.","required":false,"schema":{"type":"string","description":"Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for\navailable fields."}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtTag"}},"application/json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtTag"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtTag"}},"application/json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtTag"}}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtTag"}},"application/json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtTag"}}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtTag"}},"application/json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtTag"}}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtTag"}},"application/json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtTag"}}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtTag"}},"application/json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtTag"}}}}}},"post":{"tags":["Target Tags"],"summary":"Create target tag(s)","description":"Handles the POST request of creating new target tag. The request body must always be a list of target tags.","operationId":"createTargetTags","requestBody":{"content":{"application/hal+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtTagRequestBodyPut"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtTagRequestBodyPut"}}}},"required":true},"responses":{"201":{"description":"Successfully created","content":{"application/hal+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtTag"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtTag"}}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/hal+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtTag"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtTag"}}}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/hal+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtTag"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtTag"}}}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/hal+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtTag"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtTag"}}}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/hal+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtTag"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtTag"}}}}},"409":{"description":"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.","content":{"application/hal+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtTag"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtTag"}}}}},"415":{"description":"The request was attempt with a media-type which is not supported by the server for this resource.","content":{"application/hal+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtTag"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtTag"}}}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/hal+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtTag"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtTag"}}}}}}}},"/rest/v1/targettags/{targetTagId}/assigned/{controllerId}":{"post":{"tags":["Target Tags"],"summary":"Assign target(s) to given tagId","description":"Handles the POST request of target assignment. Already assigned target will be ignored.","operationId":"assignTarget","parameters":[{"name":"targetTagId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"controllerId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully assigned"},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication."},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies."},"405":{"description":"The http request method is not allowed on the resource."},"406":{"description":"In case accept header is specified and not application/json."},"409":{"description":"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."},"415":{"description":"The request was attempt with a media-type which is not supported by the server for this resource."},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second."}}},"delete":{"tags":["Target Tags"],"summary":"Unassign target from a given tagId","description":"Handles the DELETE request to unassign the given target.","operationId":"unassignTarget","parameters":[{"name":"targetTagId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"controllerId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved"},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication."},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies."},"404":{"description":"Target not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource."},"406":{"description":"In case accept header is specified and not application/json."},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second."}}}},"/rest/v1/targets":{"get":{"tags":["Targets"],"summary":"Return all targets","description":"Handles the GET request of retrieving all targets. Required permission: READ_TARGET","operationId":"getTargets","parameters":[{"name":"offset","in":"query","description":"The paging offset (default is 0)","required":false,"schema":{"type":"integer","description":"The paging offset (default is 0)","format":"int32","default":0}},{"name":"limit","in":"query","description":"The maximum number of entries in a page (default is 50)","required":false,"schema":{"type":"integer","description":"The maximum number of entries in a page (default is 50)","format":"int32","default":50}},{"name":"sort","in":"query","description":"The query parameter sort allows to define the sort order for the result of a query. A sort criteria\nconsists of the name of a field and the sort direction (ASC for ascending and DESC descending).\nThe sequence of the sort criteria (multiple can be used) defines the sort order of the entities\nin the result.","required":false,"schema":{"type":"string","description":"The query parameter sort allows to define the sort order for the result of a query. A sort criteria\nconsists of the name of a field and the sort direction (ASC for ascending and DESC descending).\nThe sequence of the sort criteria (multiple can be used) defines the sort order of the entities\nin the result."}},{"name":"q","in":"query","description":"Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for\navailable fields.","required":false,"schema":{"type":"string","description":"Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for\navailable fields."}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtTarget"}},"application/json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtTarget"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}},"post":{"tags":["Targets"],"summary":"Create target(s)","description":"Handles the POST request of creating new targets. The request body must always be a list of targets. Required Permission: CREATE_TARGET","operationId":"createTargets","requestBody":{"content":{"application/hal+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtTargetRequestBody"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtTargetRequestBody"}}}},"required":true},"responses":{"201":{"description":"Successfully created","content":{"application/hal+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtTarget"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtTarget"}}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"409":{"description":"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.","content":{"application/json":{}}},"415":{"description":"The request was attempt with a media-type which is not supported by the server for this resource.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/targets/{targetId}/targettype":{"post":{"tags":["Targets"],"summary":"Assign target type to a target","description":"Assign or update the target type of a target. Required permission: UPDATE_TARGET","operationId":"assignTargetType","parameters":[{"name":"targetId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtId"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtId"}}},"required":true},"responses":{"200":{"description":"Successfully retrieved"},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}},"delete":{"tags":["Targets"],"summary":"Unassign target type from target.","description":"Remove the target type from a target. The target type will be set to null. Required permission: UPDATE_TARGET","operationId":"unassignTargetType","parameters":[{"name":"targetId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved"},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/targets/{targetId}/metadata":{"get":{"tags":["Targets"],"summary":"Return metadata for specific target","description":"Get a paged list of metadata for a target. Required permission: READ_REPOSITORY","operationId":"getMetadata","parameters":[{"name":"targetId","in":"path","required":true,"schema":{"type":"string"}},{"name":"offset","in":"query","description":"The paging offset (default is 0)","required":false,"schema":{"type":"integer","description":"The paging offset (default is 0)","format":"int32","default":0}},{"name":"limit","in":"query","description":"The maximum number of entries in a page (default is 50)","required":false,"schema":{"type":"integer","description":"The maximum number of entries in a page (default is 50)","format":"int32","default":50}},{"name":"sort","in":"query","description":"The query parameter sort allows to define the sort order for the result of a query. A sort criteria\nconsists of the name of a field and the sort direction (ASC for ascending and DESC descending).\nThe sequence of the sort criteria (multiple can be used) defines the sort order of the entities\nin the result.","required":false,"schema":{"type":"string","description":"The query parameter sort allows to define the sort order for the result of a query. A sort criteria\nconsists of the name of a field and the sort direction (ASC for ascending and DESC descending).\nThe sequence of the sort criteria (multiple can be used) defines the sort order of the entities\nin the result."}},{"name":"q","in":"query","description":"Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for\navailable fields.","required":false,"schema":{"type":"string","description":"Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for\navailable fields."}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtMetadata"}},"application/json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtMetadata"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Target not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}},"post":{"tags":["Targets"],"summary":"Create a list of metadata for a specific target","description":"Create a list of metadata entries Required permissions: READ_REPOSITORY and UPDATE_TARGET","operationId":"createMetadata","parameters":[{"name":"targetId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtMetadata"}}},"application/hal+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtMetadata"}}}},"required":true},"responses":{"201":{"description":"Successfully created","content":{"application/hal+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtMetadata"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtMetadata"}}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Target not found","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"409":{"description":"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.","content":{"application/json":{}}},"415":{"description":"The request was attempt with a media-type which is not supported by the server for this resource.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/targets/{targetId}/autoConfirm/deactivate":{"post":{"tags":["Targets"],"summary":"Deactivate auto-confirm on a specific target","description":"Handles the POST request to deactivate auto-confirmation for a specific target. All active actions will remain unchanged while all future actions need to be confirmed, before processing with the deployment. Required Permission: UPDATE_TARGET","operationId":"deactivateAutoConfirm","parameters":[{"name":"targetId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved"},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Target not found","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"409":{"description":"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.","content":{"application/json":{}}},"415":{"description":"The request was attempt with a media-type which is not supported by the server for this resource.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/targets/{targetId}/autoConfirm/activate":{"post":{"tags":["Targets"],"summary":"Activate auto-confirm on a specific target","description":"Handles the POST request to activate auto-confirmation for a specific target. As a result all current active as well as future actions will automatically be confirmed by mentioning the initiator as triggered person. Actions will be automatically confirmed, as long as auto-confirmation is active. Required Permission: UPDATE_TARGET","operationId":"activateAutoConfirm","parameters":[{"name":"targetId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MgmtTargetAutoConfirmUpdate"}}}},"responses":{"200":{"description":"Successfully retrieved"},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Target not found","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"409":{"description":"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.","content":{"application/json":{}}},"415":{"description":"The request was attempt with a media-type which is not supported by the server for this resource.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/targets/{targetId}/assignedDS":{"get":{"tags":["Targets"],"summary":"Return the assigned distribution set of a specific target","description":"Handles the GET request of retrieving the assigned distribution set of an specific target. Required Permission: READ_TARGET","operationId":"getAssignedDistributionSet","parameters":[{"name":"targetId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtDistributionSet"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtDistributionSet"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Target not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}},"post":{"tags":["Targets"],"summary":"Assigns a distribution set to a specific target","description":"Handles the POST request for assigning a distribution set to a specific target. Required Permission: READ_REPOSITORY and UPDATE_TARGET","operationId":"postAssignedDistributionSet","parameters":[{"name":"targetId","in":"path","required":true,"schema":{"type":"string"}},{"name":"offline","in":"query","description":"Offline update (set param to true) that is only reported but not managed by the service, e.g.\ndefaults set in factory, manual updates or migrations from other update systems. A completed action\nis added to the history of the target(s). Target is set to IN_SYNC state as both assigned and\ninstalled DS are set. Note: only executed if the target has currently no running update","required":false,"schema":{"type":"boolean","description":"Offline update (set param to true) that is only reported but not managed by the service, e.g.\ndefaults set in factory, manual updates or migrations from other update systems. A completed action\nis added to the history of the target(s). Target is set to IN_SYNC state as both assigned and\ninstalled DS are set. Note: only executed if the target has currently no running update"}}],"requestBody":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtDistributionSetAssignments"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtDistributionSetAssignments"}}},"required":true},"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtTargetAssignmentResponseBody"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtTargetAssignmentResponseBody"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Target not found","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"409":{"description":"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.","content":{"application/json":{}}},"415":{"description":"The request was attempt with a media-type which is not supported by the server for this resource.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/targetfilters":{"get":{"tags":["Target Filter Queries"],"summary":"Return all target filter queries","description":"Handles the GET request of retrieving all target filter queries. Required permission: READ_TARGET","operationId":"getFilters","parameters":[{"name":"offset","in":"query","description":"The paging offset (default is 0)","required":false,"schema":{"type":"integer","description":"The paging offset (default is 0)","format":"int32","default":0}},{"name":"limit","in":"query","description":"The maximum number of entries in a page (default is 50)","required":false,"schema":{"type":"integer","description":"The maximum number of entries in a page (default is 50)","format":"int32","default":50}},{"name":"sort","in":"query","description":"The query parameter sort allows to define the sort order for the result of a query. A sort criteria\nconsists of the name of a field and the sort direction (ASC for ascending and DESC descending).\nThe sequence of the sort criteria (multiple can be used) defines the sort order of the entities\nin the result.","required":false,"schema":{"type":"string","description":"The query parameter sort allows to define the sort order for the result of a query. A sort criteria\nconsists of the name of a field and the sort direction (ASC for ascending and DESC descending).\nThe sequence of the sort criteria (multiple can be used) defines the sort order of the entities\nin the result."}},{"name":"q","in":"query","description":"Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for\navailable fields.","required":false,"schema":{"type":"string","description":"Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for\navailable fields."}},{"name":"representation","in":"query","required":false,"schema":{"type":"string","default":"compact"}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtTargetFilterQuery"}},"application/json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtTargetFilterQuery"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}},"post":{"tags":["Target Filter Queries"],"summary":"Create target filter","description":"Handles the POST request to create a new target filter query. Required permission: CREATE_TARGET","operationId":"createFilter","requestBody":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtTargetFilterQueryRequestBody"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtTargetFilterQueryRequestBody"}}},"required":true},"responses":{"201":{"description":"Successfully created","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtTargetFilterQuery"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtTargetFilterQuery"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"409":{"description":"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.","content":{"application/json":{}}},"415":{"description":"The request was attempt with a media-type which is not supported by the server for this resource.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/targetfilters/{filterId}/autoAssignDS":{"get":{"tags":["Target Filter Queries"],"summary":"Return distribution set for auto assignment of a specific target filter","description":"Handles the GET request of retrieving the auto assign distribution set. Required permission: READ_TARGET","operationId":"getAssignedDistributionSet_1","parameters":[{"name":"filterId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtDistributionSet"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtDistributionSet"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}},"post":{"tags":["Target Filter Queries"],"summary":"Set auto assignment of distribution set for a target filter query","description":"Handles the POST request of setting the auto assign distribution set for a target filter query. Required permissions: UPDATE_TARGET and READ_REPOSITORY","operationId":"postAssignedDistributionSet_1","parameters":[{"name":"filterId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtDistributionSetAutoAssignment"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtDistributionSetAutoAssignment"}}},"required":true},"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtTargetFilterQuery"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtTargetFilterQuery"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Target filter not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"409":{"description":"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.","content":{"application/json":{}}},"415":{"description":"The request was attempt with a media-type which is not supported by the server for this resource.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}},"delete":{"tags":["Target Filter Queries"],"summary":"Remove Distribution Set for auto assignment of a target filter","description":"Removes the auto assign distribution set from the target filter query. Required permission: UPDATE_TARGET","operationId":"deleteAssignedDistributionSet","parameters":[{"name":"filterId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successfully retrieved"},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Target filter query not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/softwaremoduletypes":{"get":{"tags":["Software Module Types"],"summary":"Return all Software Module Types","description":"Handles the GET request of retrieving all software module types. Required Permission: READ_REPOSITORY","operationId":"getTypes","parameters":[{"name":"offset","in":"query","description":"The paging offset (default is 0)","required":false,"schema":{"type":"integer","description":"The paging offset (default is 0)","format":"int32","default":0}},{"name":"limit","in":"query","description":"The maximum number of entries in a page (default is 50)","required":false,"schema":{"type":"integer","description":"The maximum number of entries in a page (default is 50)","format":"int32","default":50}},{"name":"sort","in":"query","description":"The query parameter sort allows to define the sort order for the result of a query. A sort criteria\nconsists of the name of a field and the sort direction (ASC for ascending and DESC descending).\nThe sequence of the sort criteria (multiple can be used) defines the sort order of the entities\nin the result.","required":false,"schema":{"type":"string","description":"The query parameter sort allows to define the sort order for the result of a query. A sort criteria\nconsists of the name of a field and the sort direction (ASC for ascending and DESC descending).\nThe sequence of the sort criteria (multiple can be used) defines the sort order of the entities\nin the result."}},{"name":"q","in":"query","description":"Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for\navailable fields.","required":false,"schema":{"type":"string","description":"Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for\navailable fields."}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtSoftwareModuleType"}},"application/json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtSoftwareModuleType"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}},"post":{"tags":["Software Module Types"],"summary":"Creates new Software Module Types","description":"Handles the POST request of creating new software module types. The request body must always be a list of module types. Required Permission: CREATE_REPOSITORY","operationId":"createSoftwareModuleTypes","requestBody":{"content":{"application/hal+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtSoftwareModuleTypeRequestBodyPost"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtSoftwareModuleTypeRequestBodyPost"}}}},"required":true},"responses":{"201":{"description":"Successfully created","content":{"application/hal+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtSoftwareModuleType"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtSoftwareModuleType"}}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Software Module not found","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"409":{"description":"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.","content":{"application/json":{}}},"415":{"description":"The request was attempt with a media-type which is not supported by the server for this resource.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/softwaremodules":{"get":{"tags":["Software Modules"],"summary":"Return all Software modules","description":"Handles the GET request of retrieving all softwaremodules. Required Permission: READ_REPOSITORY","operationId":"getSoftwareModules","parameters":[{"name":"offset","in":"query","description":"The paging offset (default is 0)","required":false,"schema":{"type":"integer","description":"The paging offset (default is 0)","format":"int32","default":0}},{"name":"limit","in":"query","description":"The maximum number of entries in a page (default is 50)","required":false,"schema":{"type":"integer","description":"The maximum number of entries in a page (default is 50)","format":"int32","default":50}},{"name":"sort","in":"query","description":"The query parameter sort allows to define the sort order for the result of a query. A sort criteria\nconsists of the name of a field and the sort direction (ASC for ascending and DESC descending).\nThe sequence of the sort criteria (multiple can be used) defines the sort order of the entities\nin the result.","required":false,"schema":{"type":"string","description":"The query parameter sort allows to define the sort order for the result of a query. A sort criteria\nconsists of the name of a field and the sort direction (ASC for ascending and DESC descending).\nThe sequence of the sort criteria (multiple can be used) defines the sort order of the entities\nin the result."}},{"name":"q","in":"query","description":"Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for\navailable fields.","required":false,"schema":{"type":"string","description":"Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for\navailable fields."}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtSoftwareModule"}},"application/json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtSoftwareModule"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}},"post":{"tags":["Software Modules"],"summary":"Create Software Module(s)","description":"Handles the POST request of creating new software modules. The request body must always be a list of modules. Required Permission: CREATE_REPOSITORY","operationId":"createSoftwareModules","requestBody":{"content":{"application/hal+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtSoftwareModuleRequestBodyPost"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtSoftwareModuleRequestBodyPost"}}}},"required":true},"responses":{"201":{"description":"Successfully created","content":{"application/hal+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtSoftwareModule"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtSoftwareModule"}}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"415":{"description":"The request was attempt with a media-type which is not supported by the server for this resource.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/softwaremodules/{softwareModuleId}/metadata":{"get":{"tags":["Software Modules"],"summary":"Return metadata for a Software Module","description":"Get a paged list of metadata for a software module. Required Permission: READ_REPOSITORY","operationId":"getMetadata_1","parameters":[{"name":"softwareModuleId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"offset","in":"query","description":"The paging offset (default is 0)","required":false,"schema":{"type":"integer","description":"The paging offset (default is 0)","format":"int32","default":0}},{"name":"limit","in":"query","description":"The maximum number of entries in a page (default is 50)","required":false,"schema":{"type":"integer","description":"The maximum number of entries in a page (default is 50)","format":"int32","default":50}},{"name":"sort","in":"query","description":"The query parameter sort allows to define the sort order for the result of a query. A sort criteria\nconsists of the name of a field and the sort direction (ASC for ascending and DESC descending).\nThe sequence of the sort criteria (multiple can be used) defines the sort order of the entities\nin the result.","required":false,"schema":{"type":"string","description":"The query parameter sort allows to define the sort order for the result of a query. A sort criteria\nconsists of the name of a field and the sort direction (ASC for ascending and DESC descending).\nThe sequence of the sort criteria (multiple can be used) defines the sort order of the entities\nin the result."}},{"name":"q","in":"query","description":"Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for\navailable fields.","required":false,"schema":{"type":"string","description":"Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for\navailable fields."}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtSoftwareModuleMetadata"}},"application/json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtSoftwareModuleMetadata"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Software Module not found ","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}},"post":{"tags":["Software Modules"],"summary":"Creates a list of metadata for a specific Software Module","description":"Create a list of metadata entries Required Permission: UPDATE_REPOSITORY","operationId":"createMetadata_1","parameters":[{"name":"softwareModuleId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtSoftwareModuleMetadata"}}},"application/hal+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtSoftwareModuleMetadata"}}}},"required":true},"responses":{"201":{"description":"Successfully created","content":{"application/hal+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtSoftwareModuleMetadata"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtSoftwareModuleMetadata"}}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Software Module not found","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"409":{"description":"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.","content":{"application/json":{}}},"415":{"description":"The request was attempt with a media-type which is not supported by the server for this resource.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/softwaremodules/{softwareModuleId}/artifacts":{"get":{"tags":["Software Modules"],"summary":"Return all metadata of artifacts assigned to a software module","description":"Handles the GET request of retrieving all metadata of artifacts assigned to a software module. Required Permission: READ_REPOSITORY","operationId":"getArtifacts","parameters":[{"name":"softwareModuleId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"representation","in":"query","required":false,"schema":{"type":"string","default":"compact"}},{"name":"useartifacturlhandler","in":"query","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtArtifact"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtArtifact"}}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Software Module not found ","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}},"post":{"tags":["Software Modules"],"summary":"Upload artifact","description":"Handles POST request for artifact upload. Required Permission: CREATE_REPOSITORY","operationId":"uploadArtifact","parameters":[{"name":"softwareModuleId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"filename","in":"query","required":false,"schema":{"type":"string"}},{"name":"md5sum","in":"query","required":false,"schema":{"type":"string"}},{"name":"sha1sum","in":"query","required":false,"schema":{"type":"string"}},{"name":"sha256sum","in":"query","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"201":{"description":"Successfully created","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtArtifact"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtArtifact"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Software Module not found","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"415":{"description":"The request was attempt with a media-type which is not supported by the server for this resource.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/rollouts":{"get":{"tags":["Rollouts"],"summary":"Return all Rollouts","description":"Handles the GET request of retrieving all rollouts. Required Permission: READ_ROLLOUT","operationId":"getRollouts","parameters":[{"name":"offset","in":"query","description":"The paging offset (default is 0)","required":false,"schema":{"type":"integer","description":"The paging offset (default is 0)","format":"int32","default":0}},{"name":"limit","in":"query","description":"The maximum number of entries in a page (default is 50)","required":false,"schema":{"type":"integer","description":"The maximum number of entries in a page (default is 50)","format":"int32","default":50}},{"name":"sort","in":"query","description":"The query parameter sort allows to define the sort order for the result of a query. A sort criteria\nconsists of the name of a field and the sort direction (ASC for ascending and DESC descending).\nThe sequence of the sort criteria (multiple can be used) defines the sort order of the entities\nin the result.","required":false,"schema":{"type":"string","description":"The query parameter sort allows to define the sort order for the result of a query. A sort criteria\nconsists of the name of a field and the sort direction (ASC for ascending and DESC descending).\nThe sequence of the sort criteria (multiple can be used) defines the sort order of the entities\nin the result."}},{"name":"q","in":"query","description":"Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for\navailable fields.","required":false,"schema":{"type":"string","description":"Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for\navailable fields."}},{"name":"representation","in":"query","required":false,"schema":{"type":"string","default":"compact"}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtRolloutResponseBody"}},"application/json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtRolloutResponseBody"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}},"post":{"tags":["Rollouts"],"summary":"Create a new Rollout","description":"Handles the POST request of creating new rollout. Required Permission: CREATE_ROLLOUT","operationId":"create","requestBody":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtRolloutRestRequestBodyPost"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtRolloutRestRequestBodyPost"}}},"required":true},"responses":{"201":{"description":"Successfully created","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtRolloutResponseBody"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtRolloutResponseBody"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"409":{"description":"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.","content":{"application/json":{}}},"415":{"description":"The request was attempt with a media-type which is not supported by the server for this resource.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/rollouts/{rolloutId}/triggerNextGroup":{"post":{"tags":["Rollouts"],"summary":"Force trigger processing next group of a Rollout","description":"Handles the POST request of triggering the next group of a rollout. Required Permission: UPDATE_ROLLOUT","operationId":"triggerNextGroup","parameters":[{"name":"rolloutId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successfully retrieved"},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/rollouts/{rolloutId}/start":{"post":{"tags":["Rollouts"],"summary":"Start a Rollout","description":"Handles the POST request of starting a created rollout. Required Permission: HANDLE_ROLLOUT","operationId":"start","parameters":[{"name":"rolloutId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successfully retrieved"},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/rollouts/{rolloutId}/retry":{"post":{"tags":["Rollouts"],"summary":"Retry a rollout","description":"Handles the POST request of retrying a rollout. Required Permission: CREATE_ROLLOUT","operationId":"retryRollout","parameters":[{"name":"rolloutId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"201":{"description":"Successfully created","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtRolloutResponseBody"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtRolloutResponseBody"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Rollout not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/rollouts/{rolloutId}/resume":{"post":{"tags":["Rollouts"],"summary":"Resume a Rollout","description":"Handles the POST request of resuming a paused rollout. Required Permission: HANDLE_ROLLOUT","operationId":"resume","parameters":[{"name":"rolloutId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successfully retrieved"},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/rollouts/{rolloutId}/pause":{"post":{"tags":["Rollouts"],"summary":"Pause a Rollout","description":"Handles the POST request of pausing a running rollout. Required Permission: HANDLE_ROLLOUT","operationId":"pause","parameters":[{"name":"rolloutId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successfully retrieved"},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/rollouts/{rolloutId}/deny":{"post":{"tags":["Rollouts"],"summary":"Deny a Rollout","description":"Handles the POST request of denying a created rollout. Only possible if approval workflow is enabled in system configuration and rollout is in state WAITING_FOR_APPROVAL. Required Permission: APPROVE_ROLLOUT","operationId":"deny","parameters":[{"name":"rolloutId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"remark","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved"},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/rollouts/{rolloutId}/approve":{"post":{"tags":["Rollouts"],"summary":"Approve a Rollout","description":"Handles the POST request of approving a created rollout. Only possible if approval workflow is enabled in system configuration and rollout is in state WAITING_FOR_APPROVAL. Required Permission: APPROVE_ROLLOUT","operationId":"approve","parameters":[{"name":"rolloutId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"remark","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved"},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/distributionsettypes":{"get":{"tags":["Distribution Set Types"],"summary":"Return all Distribution Set Types","description":"Handles the GET request of retrieving all distribution set types. Required Permission: READ_REPOSITORY","operationId":"getDistributionSetTypes","parameters":[{"name":"offset","in":"query","description":"The paging offset (default is 0)","required":false,"schema":{"type":"integer","description":"The paging offset (default is 0)","format":"int32","default":0}},{"name":"limit","in":"query","description":"The maximum number of entries in a page (default is 50)","required":false,"schema":{"type":"integer","description":"The maximum number of entries in a page (default is 50)","format":"int32","default":50}},{"name":"sort","in":"query","description":"The query parameter sort allows to define the sort order for the result of a query. A sort criteria\nconsists of the name of a field and the sort direction (ASC for ascending and DESC descending).\nThe sequence of the sort criteria (multiple can be used) defines the sort order of the entities\nin the result.","required":false,"schema":{"type":"string","description":"The query parameter sort allows to define the sort order for the result of a query. A sort criteria\nconsists of the name of a field and the sort direction (ASC for ascending and DESC descending).\nThe sequence of the sort criteria (multiple can be used) defines the sort order of the entities\nin the result."}},{"name":"q","in":"query","description":"Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for\navailable fields.","required":false,"schema":{"type":"string","description":"Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for\navailable fields."}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtDistributionSetType"}},"application/json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtDistributionSetType"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}},"post":{"tags":["Distribution Set Types"],"summary":"Create new distribution set types","description":"Handles the POST request for creating new distribution set types. The request body must always be a list of types. Required Permission: CREATE_REPOSITORY","operationId":"createDistributionSetTypes","requestBody":{"content":{"application/hal+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtDistributionSetTypeRequestBodyPost"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtDistributionSetTypeRequestBodyPost"}}}},"required":true},"responses":{"201":{"description":"Successfully created","content":{"application/hal+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtDistributionSetType"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtDistributionSetType"}}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"409":{"description":"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.","content":{"application/json":{}}},"415":{"description":"The request was attempt with a media-type which is not supported by the server for this resource.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/distributionsettypes/{distributionSetTypeId}/optionalmoduletypes":{"get":{"tags":["Distribution Set Types"],"summary":"Return optional Software Module Types in a Distribution Set Type","description":"Handles the GET request of retrieving the list of optional software module types in that distribution set type. Required Permission: READ_REPOSITORY","operationId":"getOptionalModules","parameters":[{"name":"distributionSetTypeId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtSoftwareModuleType"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtSoftwareModuleType"}}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Distribution Set Type not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}},"post":{"tags":["Distribution Set Types"],"summary":"Add optional Software Module Type to a Distribution Set Type","description":"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","operationId":"addOptionalModule","parameters":[{"name":"distributionSetTypeId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtId"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtId"}}},"required":true},"responses":{"200":{"description":"Successfully retrieved"},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Distribution Set Type not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"409":{"description":"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.","content":{"application/json":{}}},"415":{"description":"The request was attempt with a media-type which is not supported by the server for this resource.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/distributionsettypes/{distributionSetTypeId}/mandatorymoduletypes":{"get":{"tags":["Distribution Set Types"],"summary":"Return mandatory Software Module Types in a Distribution Set Type","description":"Handles the GET request of retrieving the list of mandatory software module types in that distribution set type. Required Permission: READ_REPOSITORY","operationId":"getMandatoryModules","parameters":[{"name":"distributionSetTypeId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtSoftwareModuleType"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtSoftwareModuleType"}}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Distribution Set Type not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}},"post":{"tags":["Distribution Set Types"],"summary":"Add mandatory Software Module Type to a Distribution Set Type","description":"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","operationId":"addMandatoryModule","parameters":[{"name":"distributionSetTypeId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtId"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtId"}}},"required":true},"responses":{"200":{"description":"Successfully retrieved"},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Distribution Set Type not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"409":{"description":"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.","content":{"application/json":{}}},"415":{"description":"The request was attempt with a media-type which is not supported by the server for this resource.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/distributionsettags":{"get":{"tags":["Distribution Set Tags"],"summary":"Return all Distribution Set Tags","description":"Handles the GET request of retrieving all distribution set tags.","operationId":"getDistributionSetTags","parameters":[{"name":"offset","in":"query","description":"The paging offset (default is 0)","required":false,"schema":{"type":"integer","description":"The paging offset (default is 0)","format":"int32","default":0}},{"name":"limit","in":"query","description":"The maximum number of entries in a page (default is 50)","required":false,"schema":{"type":"integer","description":"The maximum number of entries in a page (default is 50)","format":"int32","default":50}},{"name":"sort","in":"query","description":"The query parameter sort allows to define the sort order for the result of a query. A sort criteria\nconsists of the name of a field and the sort direction (ASC for ascending and DESC descending).\nThe sequence of the sort criteria (multiple can be used) defines the sort order of the entities\nin the result.","required":false,"schema":{"type":"string","description":"The query parameter sort allows to define the sort order for the result of a query. A sort criteria\nconsists of the name of a field and the sort direction (ASC for ascending and DESC descending).\nThe sequence of the sort criteria (multiple can be used) defines the sort order of the entities\nin the result."}},{"name":"q","in":"query","description":"Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for\navailable fields.","required":false,"schema":{"type":"string","description":"Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for\navailable fields."}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtTag"}},"application/json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtTag"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}},"post":{"tags":["Distribution Set Tags"],"summary":"Creates new Distribution Set Tags","description":"Handles the POST request of creating new distribution set tag. The request body must always be a list of distribution set tags.","operationId":"createDistributionSetTags","requestBody":{"content":{"application/hal+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtTagRequestBodyPut"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtTagRequestBodyPut"}}}},"required":true},"responses":{"201":{"description":"Successfully created","content":{"application/hal+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtTag"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtTag"}}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"409":{"description":"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.","content":{"application/json":{}}},"415":{"description":"The request was attempt with a media-type which is not supported by the server for this resource.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/distributionsettags/{distributionsetTagId}/assigned/{distributionsetId}":{"post":{"tags":["Distribution Set Tags"],"summary":"Assign distribution set to the given tag id","description":"Handles the POST request of distribution assignment. Already assigned distribution will be ignored.","operationId":"assignDistributionSet","parameters":[{"name":"distributionsetTagId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"distributionsetId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successfully retrieved"},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"409":{"description":"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.","content":{"application/json":{}}},"415":{"description":"The request was attempt with a media-type which is not supported by the server for this resource.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}},"delete":{"tags":["Distribution Set Tags"],"summary":"Unassign one distribution set from the given tag id","description":"Handles the DELETE request of unassign the given distribution.","operationId":"unassignDistributionSet","parameters":[{"name":"distributionsetTagId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"distributionsetId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successfully retrieved"},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Distribution Set Tag not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/distributionsets":{"get":{"tags":["Distribution Sets"],"summary":"Return all Distribution Sets","description":"Handles the GET request of retrieving all distribution sets. Required permission: READ_REPOSITORY","operationId":"getDistributionSets","parameters":[{"name":"offset","in":"query","description":"The paging offset (default is 0)","required":false,"schema":{"type":"integer","description":"The paging offset (default is 0)","format":"int32","default":0}},{"name":"limit","in":"query","description":"The maximum number of entries in a page (default is 50)","required":false,"schema":{"type":"integer","description":"The maximum number of entries in a page (default is 50)","format":"int32","default":50}},{"name":"sort","in":"query","description":"The query parameter sort allows to define the sort order for the result of a query. A sort criteria\nconsists of the name of a field and the sort direction (ASC for ascending and DESC descending).\nThe sequence of the sort criteria (multiple can be used) defines the sort order of the entities\nin the result.","required":false,"schema":{"type":"string","description":"The query parameter sort allows to define the sort order for the result of a query. A sort criteria\nconsists of the name of a field and the sort direction (ASC for ascending and DESC descending).\nThe sequence of the sort criteria (multiple can be used) defines the sort order of the entities\nin the result."}},{"name":"q","in":"query","description":"Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for\navailable fields.","required":false,"schema":{"type":"string","description":"Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for\navailable fields."}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtDistributionSet"}},"application/json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtDistributionSet"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}},"post":{"tags":["Distribution Sets"],"summary":"Creates new Distribution Sets","description":"Handles the POST request of creating new distribution sets within Hawkbit. The request body must always be a list of sets. Required permission: CREATE_REPOSITORY","operationId":"createDistributionSets","requestBody":{"content":{"application/hal+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtDistributionSetRequestBodyPost"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtDistributionSetRequestBodyPost"}}}},"required":true},"responses":{"201":{"description":"Successfully created","content":{"application/hal+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtDistributionSet"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtDistributionSet"}}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"409":{"description":"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.","content":{"application/json":{}}},"415":{"description":"The request was attempt with a media-type which is not supported by the server for this resource.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/distributionsets/{distributionSetId}/metadata":{"get":{"tags":["Distribution Sets"],"summary":"Return meta data for Distribution Set","description":"Get a paged list of meta data for a distribution set. Required permission: READ_REPOSITORY","operationId":"getMetadata_2","parameters":[{"name":"distributionSetId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"offset","in":"query","description":"The paging offset (default is 0)","required":false,"schema":{"type":"integer","description":"The paging offset (default is 0)","format":"int32","default":0}},{"name":"limit","in":"query","description":"The maximum number of entries in a page (default is 50)","required":false,"schema":{"type":"integer","description":"The maximum number of entries in a page (default is 50)","format":"int32","default":50}},{"name":"sort","in":"query","description":"The query parameter sort allows to define the sort order for the result of a query. A sort criteria\nconsists of the name of a field and the sort direction (ASC for ascending and DESC descending).\nThe sequence of the sort criteria (multiple can be used) defines the sort order of the entities\nin the result.","required":false,"schema":{"type":"string","description":"The query parameter sort allows to define the sort order for the result of a query. A sort criteria\nconsists of the name of a field and the sort direction (ASC for ascending and DESC descending).\nThe sequence of the sort criteria (multiple can be used) defines the sort order of the entities\nin the result."}},{"name":"q","in":"query","description":"Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for\navailable fields.","required":false,"schema":{"type":"string","description":"Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for\navailable fields."}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtMetadata"}},"application/json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtMetadata"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Distribution Set not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}},"post":{"tags":["Distribution Sets"],"summary":"Create a list of meta data for a specific distribution set","description":"Create a list of meta data entries Required permissions: READ_REPOSITORY and UPDATE_TARGET","operationId":"createMetadata_2","parameters":[{"name":"distributionSetId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtMetadata"}}},"application/hal+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtMetadata"}}}},"required":true},"responses":{"201":{"description":"Successfully created","content":{"application/hal+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtMetadata"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtMetadata"}}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Distribution Set not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"409":{"description":"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.","content":{"application/json":{}}},"415":{"description":"The request was attempt with a media-type which is not supported by the server for this resource.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/distributionsets/{distributionSetId}/invalidate":{"post":{"tags":["Distribution Sets"],"summary":"Invalidate a distribution set","description":"Invalidate a distribution set. Once a distribution set is invalidated, it can not be valid again. An invalidated\ndistribution set cannot be assigned to targets anymore. The distribution set that is going to be invalidated\nwill be removed from all auto assignments. Furthermore, the user can choose to cancel all rollouts and (force)\ncancel all actions connected to this distribution set. Required permission: UPDATE_REPOSITORY, UPDATE_TARGET\n","operationId":"invalidateDistributionSet","parameters":[{"name":"distributionSetId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtInvalidateDistributionSetRequestBody"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtInvalidateDistributionSetRequestBody"}}},"required":true},"responses":{"200":{"description":"Successfully retrieved"},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Distribution Set not found","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"409":{"description":"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.","content":{"application/json":{}}},"415":{"description":"The request was attempt with a media-type which is not supported by the server for this resource.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/distributionsets/{distributionSetId}/assignedTargets":{"get":{"tags":["Distribution Sets"],"summary":"Return assigned targets to a specific distribution set","description":"Handles the GET request for retrieving assigned targets of a single distribution set. Required permissions: READ_REPOSITORY and READ_TARGET","operationId":"getAssignedTargets_1","parameters":[{"name":"distributionSetId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"offset","in":"query","description":"The paging offset (default is 0)","required":false,"schema":{"type":"integer","description":"The paging offset (default is 0)","format":"int32","default":0}},{"name":"limit","in":"query","description":"The maximum number of entries in a page (default is 50)","required":false,"schema":{"type":"integer","description":"The maximum number of entries in a page (default is 50)","format":"int32","default":50}},{"name":"sort","in":"query","description":"The query parameter sort allows to define the sort order for the result of a query. A sort criteria\nconsists of the name of a field and the sort direction (ASC for ascending and DESC descending).\nThe sequence of the sort criteria (multiple can be used) defines the sort order of the entities\nin the result.","required":false,"schema":{"type":"string","description":"The query parameter sort allows to define the sort order for the result of a query. A sort criteria\nconsists of the name of a field and the sort direction (ASC for ascending and DESC descending).\nThe sequence of the sort criteria (multiple can be used) defines the sort order of the entities\nin the result."}},{"name":"q","in":"query","description":"Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for\navailable fields.","required":false,"schema":{"type":"string","description":"Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for\navailable fields."}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtTarget"}},"application/json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtTarget"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Distribution Set not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}},"post":{"tags":["Distribution Sets"],"summary":"Assigning multiple targets to a single distribution set","description":"Handles the POST request for assigning multiple targets to a distribution set.The request body must always be a list of target IDs. Non-existing targets are silently ignored resulting in a valid response. Required permissions: READ_REPOSITORY and UPDATE_TARGET","operationId":"createAssignedTarget","parameters":[{"name":"distributionSetId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"offline","in":"query","required":false,"schema":{"type":"boolean"}}],"requestBody":{"content":{"application/hal+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtTargetAssignmentRequestBody"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtTargetAssignmentRequestBody"}}}},"required":true},"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtTargetAssignmentResponseBody"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtTargetAssignmentResponseBody"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"409":{"description":"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.","content":{"application/json":{}}},"415":{"description":"The request was attempt with a media-type which is not supported by the server for this resource.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/distributionsets/{distributionSetId}/assignedSM":{"get":{"tags":["Distribution Sets"],"summary":"Return the assigned software modules of a specific distribution set","description":"Handles the GET request of retrieving a single distribution set. Required permission: READ_REPOSITORY","operationId":"getAssignedSoftwareModules","parameters":[{"name":"distributionSetId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"offset","in":"query","description":"The paging offset (default is 0)","required":false,"schema":{"type":"integer","description":"The paging offset (default is 0)","format":"int32","default":0}},{"name":"limit","in":"query","description":"The maximum number of entries in a page (default is 50)","required":false,"schema":{"type":"integer","description":"The maximum number of entries in a page (default is 50)","format":"int32","default":50}},{"name":"sort","in":"query","description":"The query parameter sort allows to define the sort order for the result of a query. A sort criteria\nconsists of the name of a field and the sort direction (ASC for ascending and DESC descending).\nThe sequence of the sort criteria (multiple can be used) defines the sort order of the entities\nin the result.","required":false,"schema":{"type":"string","description":"The query parameter sort allows to define the sort order for the result of a query. A sort criteria\nconsists of the name of a field and the sort direction (ASC for ascending and DESC descending).\nThe sequence of the sort criteria (multiple can be used) defines the sort order of the entities\nin the result."}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtSoftwareModule"}},"application/json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtSoftwareModule"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Distribution Set not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}},"post":{"tags":["Distribution Sets"],"summary":"Assign a list of software modules to a distribution set","description":"Handles the POST request for assigning multiple software modules to a distribution set.The request body must\nalways be a list of software module IDs. Required permissions: READ_REPOSITORY and UPDATE_REPOSITORY\n","operationId":"assignSoftwareModules","parameters":[{"name":"distributionSetId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtSoftwareModuleAssignment"}}},"application/hal+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtSoftwareModuleAssignment"}}}},"required":true},"responses":{"200":{"description":"Successfully retrieved"},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Distribution Set not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"409":{"description":"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.","content":{"application/json":{}}},"415":{"description":"The request was attempt with a media-type which is not supported by the server for this resource.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/userinfo":{"get":{"tags":["Basic Authentication"],"operationId":"validateBasicAuth","responses":{"200":{"description":"OK","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtUserInfo"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtUserInfo"}}}}}}},"/rest/v1/targets/{targetId}/tags":{"get":{"tags":["Targets"],"summary":"Return tags for specific target","description":"Get a paged list of tags for a target. Required permission: READ_REPOSITORY","operationId":"getTags","parameters":[{"name":"targetId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtTag"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MgmtTag"}}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Target not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/targets/{targetId}/installedDS":{"get":{"tags":["Targets"],"summary":"Return installed distribution set of a specific target","description":"Handles the GET request of retrieving the installed distribution set of an specific target. Required Permission: READ_TARGET","operationId":"getInstalledDistributionSet","parameters":[{"name":"targetId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtDistributionSet"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtDistributionSet"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Target not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/targets/{targetId}/autoConfirm":{"get":{"tags":["Targets"],"summary":"Return the current auto-confitm state for a specific target","description":"Handles the GET request to check the current auto-confirmation state of a target. Required Permission: READ_TARGET","operationId":"getAutoConfirmStatus","parameters":[{"name":"targetId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtTargetAutoConfirm"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtTargetAutoConfirm"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Target not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/targets/{targetId}/attributes":{"get":{"tags":["Targets"],"summary":"Return attributes of a specific target","description":"Handles the GET request of retrieving the attributes of a specific target. Reponse is a key/value list. Required Permission: READ_TARGET","operationId":"getAttributes","parameters":[{"name":"targetId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtTargetAttributes"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtTargetAttributes"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Target not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/targets/{targetId}/actions":{"get":{"tags":["Targets"],"summary":"Return actions for a specific target","description":"Handles the GET request of retrieving the full action history of a specific target. Required Permission: READ_TARGET","operationId":"getActionHistory","parameters":[{"name":"targetId","in":"path","required":true,"schema":{"type":"string"}},{"name":"offset","in":"query","description":"The paging offset (default is 0)","required":false,"schema":{"type":"integer","description":"The paging offset (default is 0)","format":"int32","default":0}},{"name":"limit","in":"query","description":"The maximum number of entries in a page (default is 50)","required":false,"schema":{"type":"integer","description":"The maximum number of entries in a page (default is 50)","format":"int32","default":50}},{"name":"sort","in":"query","description":"The query parameter sort allows to define the sort order for the result of a query. A sort criteria\nconsists of the name of a field and the sort direction (ASC for ascending and DESC descending).\nThe sequence of the sort criteria (multiple can be used) defines the sort order of the entities\nin the result.","required":false,"schema":{"type":"string","description":"The query parameter sort allows to define the sort order for the result of a query. A sort criteria\nconsists of the name of a field and the sort direction (ASC for ascending and DESC descending).\nThe sequence of the sort criteria (multiple can be used) defines the sort order of the entities\nin the result."}},{"name":"q","in":"query","description":"Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for\navailable fields.","required":false,"schema":{"type":"string","description":"Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for\navailable fields."}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtAction"}},"application/json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtAction"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Target not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/targets/{targetId}/actions/{actionId}/status":{"get":{"tags":["Targets"],"summary":"Return status of a specific action on a specific target","description":"Handles the GET request of retrieving a specific action on a specific target. Required Permission: READ_TARGET","operationId":"getActionStatusList","parameters":[{"name":"targetId","in":"path","required":true,"schema":{"type":"string"}},{"name":"actionId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":50}},{"name":"sort","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtActionStatus"}},"application/json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtActionStatus"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Target not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/softwaremodules/{softwareModuleId}/artifacts/{artifactId}":{"get":{"tags":["Software Modules"],"summary":"Return single Artifact metadata","description":"Handles the GET request of retrieving a single Artifact metadata request. Required Permission: READ_REPOSITORY","operationId":"getArtifact","parameters":[{"name":"softwareModuleId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"artifactId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"useartifacturlhandler","in":"query","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtArtifact"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtArtifact"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Software Module not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}},"delete":{"tags":["Software Modules"],"summary":"Delete artifact by Id","description":"Handles the DELETE request for a single Artifact assigned to a SoftwareModule. Required Permission: DELETE_REPOSITORY","operationId":"deleteArtifact","parameters":[{"name":"softwareModuleId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"artifactId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successfully retrieved"},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Software Module not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/softwaremodules/{softwareModuleId}/artifacts/{artifactId}/download":{"get":{"tags":["Download artifact"],"operationId":"downloadArtifact_1","parameters":[{"name":"softwareModuleId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"artifactId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"object"}}}}}}},"/rest/v1/rollouts/{rolloutId}/deploygroups":{"get":{"tags":["Rollouts"],"summary":"Return all rollout groups referred to a Rollout","description":"Handles the GET request of retrieving all deploy groups of a specific rollout. Required Permission: READ_ROLLOUT","operationId":"getRolloutGroups","parameters":[{"name":"rolloutId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"offset","in":"query","description":"The paging offset (default is 0)","required":false,"schema":{"type":"integer","description":"The paging offset (default is 0)","format":"int32","default":0}},{"name":"limit","in":"query","description":"The maximum number of entries in a page (default is 50)","required":false,"schema":{"type":"integer","description":"The maximum number of entries in a page (default is 50)","format":"int32","default":50}},{"name":"sort","in":"query","description":"The query parameter sort allows to define the sort order for the result of a query. A sort criteria\nconsists of the name of a field and the sort direction (ASC for ascending and DESC descending).\nThe sequence of the sort criteria (multiple can be used) defines the sort order of the entities\nin the result.","required":false,"schema":{"type":"string","description":"The query parameter sort allows to define the sort order for the result of a query. A sort criteria\nconsists of the name of a field and the sort direction (ASC for ascending and DESC descending).\nThe sequence of the sort criteria (multiple can be used) defines the sort order of the entities\nin the result."}},{"name":"q","in":"query","description":"Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for\navailable fields.","required":false,"schema":{"type":"string","description":"Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for\navailable fields."}},{"name":"representation","in":"query","required":false,"schema":{"type":"string","default":"compact"}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtRolloutGroupResponseBody"}},"application/json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtRolloutGroupResponseBody"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Rollout not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/rollouts/{rolloutId}/deploygroups/{groupId}":{"get":{"tags":["Rollouts"],"summary":"Return single rollout group","description":"Handles the GET request of a single deploy group of a specific rollout. Required Permission: READ_ROLLOUT","operationId":"getRolloutGroup","parameters":[{"name":"rolloutId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"groupId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtRolloutGroupResponseBody"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtRolloutGroupResponseBody"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Rollout not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/rollouts/{rolloutId}/deploygroups/{groupId}/targets":{"get":{"tags":["Rollouts"],"summary":"Return all targets related to a specific rollout group","description":"Handles the GET request of retrieving all targets of a single deploy group of a specific rollout. Required Permissions: READ_ROLLOUT, READ_TARGET.","operationId":"getRolloutGroupTargets","parameters":[{"name":"rolloutId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"groupId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"offset","in":"query","description":"The paging offset (default is 0)","required":false,"schema":{"type":"integer","description":"The paging offset (default is 0)","format":"int32","default":0}},{"name":"limit","in":"query","description":"The maximum number of entries in a page (default is 50)","required":false,"schema":{"type":"integer","description":"The maximum number of entries in a page (default is 50)","format":"int32","default":50}},{"name":"sort","in":"query","description":"The query parameter sort allows to define the sort order for the result of a query. A sort criteria\nconsists of the name of a field and the sort direction (ASC for ascending and DESC descending).\nThe sequence of the sort criteria (multiple can be used) defines the sort order of the entities\nin the result.","required":false,"schema":{"type":"string","description":"The query parameter sort allows to define the sort order for the result of a query. A sort criteria\nconsists of the name of a field and the sort direction (ASC for ascending and DESC descending).\nThe sequence of the sort criteria (multiple can be used) defines the sort order of the entities\nin the result."}},{"name":"q","in":"query","description":"Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for\navailable fields.","required":false,"schema":{"type":"string","description":"Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for\navailable fields."}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtTarget"}},"application/json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtTarget"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Rollout not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/distributionsettypes/{distributionSetTypeId}/optionalmoduletypes/{softwareModuleTypeId}":{"get":{"tags":["Distribution Set Types"],"summary":"Return single optional Software Module Type in a Distribution Set Type","description":"Handles the GET request of retrieving the single optional software module type in that distribution set type. Required Permission: READ_REPOSITORY","operationId":"getOptionalModule","parameters":[{"name":"distributionSetTypeId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"softwareModuleTypeId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtSoftwareModuleType"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtSoftwareModuleType"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Distribution Set Type not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}},"delete":{"tags":["Distribution Set Types"],"summary":"Delete an optional module from a Distribution Set Type","description":"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","operationId":"removeOptionalModule","parameters":[{"name":"distributionSetTypeId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"softwareModuleTypeId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successfully retrieved"},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Distribution Set Type not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/distributionsettypes/{distributionSetTypeId}/mandatorymoduletypes/{softwareModuleTypeId}":{"get":{"tags":["Distribution Set Types"],"summary":"Return single mandatory Software Module Type in a Distribution Set Type","description":"Handles the GET request of retrieving the single mandatory software module type in that distribution set type. Required Permission: READ_REPOSITORY","operationId":"getMandatoryModule","parameters":[{"name":"distributionSetTypeId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"softwareModuleTypeId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtSoftwareModuleType"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtSoftwareModuleType"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Distribution Set Type not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}},"delete":{"tags":["Distribution Set Types"],"summary":"Delete a mandatory module from a Distribution Set Type","description":"Handles the DELETE request for removing a software module type from a single distribution set type. Required Permission: DELETE_REPOSITORY","operationId":"removeMandatoryModule","parameters":[{"name":"distributionSetTypeId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"softwareModuleTypeId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successfully retrieved"},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Distribution Set Type not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/distributionsets/{distributionSetId}/statistics":{"get":{"tags":["Distribution Sets"],"summary":"Return Rollouts, Actions and Auto Assignments counts by Status for Distribution Set","description":"Handles the GET request of retrieving Rollouts, Actions and Auto Assignments counts by Status for Distribution Set","operationId":"getStatisticsForDistributionSet","parameters":[{"name":"distributionSetId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtDistributionSetStatistics"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtDistributionSetStatistics"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Distribution Set not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/distributionsets/{distributionSetId}/statistics/rollouts":{"get":{"tags":["Distribution Sets"],"summary":"Return Rollouts count by status for Distribution Set","description":"Handles the GET request of retrieving Rollouts count by Status for Distribution Set","operationId":"getRolloutsCountByStatusForDistributionSet","parameters":[{"name":"distributionSetId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtDistributionSetStatistics"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtDistributionSetStatistics"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Distribution Set not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/distributionsets/{distributionSetId}/statistics/autoassignments":{"get":{"tags":["Distribution Sets"],"summary":"Return Auto Assignments count for Distribution Set","description":"Handles the GET request of retrieving Auto Assignments count for Distribution Set","operationId":"getAutoAssignmentsCountForDistributionSet","parameters":[{"name":"distributionSetId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtDistributionSetStatistics"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtDistributionSetStatistics"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Distribution Set not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/distributionsets/{distributionSetId}/statistics/actions":{"get":{"tags":["Distribution Sets"],"summary":"Return Actions count by status for Distribution Set","description":"Handles the GET request of retrieving Actions count by Status for Distribution Set","operationId":"getActionsCountByStatusForDistributionSet","parameters":[{"name":"distributionSetId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtDistributionSetStatistics"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtDistributionSetStatistics"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Distribution Set not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/distributionsets/{distributionSetId}/installedTargets":{"get":{"tags":["Distribution Sets"],"summary":"Return installed targets to a specific distribution set","description":"Handles the GET request for retrieving installed targets of a single distribution set. Required permissions: READ_REPOSITORY and READ_TARGET","operationId":"getInstalledTargets","parameters":[{"name":"distributionSetId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"offset","in":"query","description":"The paging offset (default is 0)","required":false,"schema":{"type":"integer","description":"The paging offset (default is 0)","format":"int32","default":0}},{"name":"limit","in":"query","description":"The maximum number of entries in a page (default is 50)","required":false,"schema":{"type":"integer","description":"The maximum number of entries in a page (default is 50)","format":"int32","default":50}},{"name":"sort","in":"query","description":"The query parameter sort allows to define the sort order for the result of a query. A sort criteria\nconsists of the name of a field and the sort direction (ASC for ascending and DESC descending).\nThe sequence of the sort criteria (multiple can be used) defines the sort order of the entities\nin the result.","required":false,"schema":{"type":"string","description":"The query parameter sort allows to define the sort order for the result of a query. A sort criteria\nconsists of the name of a field and the sort direction (ASC for ascending and DESC descending).\nThe sequence of the sort criteria (multiple can be used) defines the sort order of the entities\nin the result."}},{"name":"q","in":"query","description":"Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for\navailable fields.","required":false,"schema":{"type":"string","description":"Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for\navailable fields."}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtTarget"}},"application/json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtTarget"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Distribution Set not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/distributionsets/{distributionSetId}/autoAssignTargetFilters":{"get":{"tags":["Distribution Sets"],"summary":"Return target filter queries that have the given distribution set as auto assign DS","description":"Handles the GET request for retrieving assigned target filter queries of a single distribution set. Required permissions: READ_REPOSITORY and READ_TARGET","operationId":"getAutoAssignTargetFilterQueries","parameters":[{"name":"distributionSetId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"offset","in":"query","description":"The paging offset (default is 0)","required":false,"schema":{"type":"integer","description":"The paging offset (default is 0)","format":"int32","default":0}},{"name":"limit","in":"query","description":"The maximum number of entries in a page (default is 50)","required":false,"schema":{"type":"integer","description":"The maximum number of entries in a page (default is 50)","format":"int32","default":50}},{"name":"sort","in":"query","description":"The query parameter sort allows to define the sort order for the result of a query. A sort criteria\nconsists of the name of a field and the sort direction (ASC for ascending and DESC descending).\nThe sequence of the sort criteria (multiple can be used) defines the sort order of the entities\nin the result.","required":false,"schema":{"type":"string","description":"The query parameter sort allows to define the sort order for the result of a query. A sort criteria\nconsists of the name of a field and the sort direction (ASC for ascending and DESC descending).\nThe sequence of the sort criteria (multiple can be used) defines the sort order of the entities\nin the result."}},{"name":"q","in":"query","description":"Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for\navailable fields.","required":false,"schema":{"type":"string","description":"Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for\navailable fields."}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtTargetFilterQuery"}},"application/json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtTargetFilterQuery"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Distribution Set not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/actions":{"get":{"tags":["Actions"],"summary":"Return all actions","description":"Handles the GET request of retrieving all actions.","operationId":"getActions","parameters":[{"name":"offset","in":"query","description":"The paging offset (default is 0)","required":false,"schema":{"type":"integer","description":"The paging offset (default is 0)","format":"int32","default":0}},{"name":"limit","in":"query","description":"The maximum number of entries in a page (default is 50)","required":false,"schema":{"type":"integer","description":"The maximum number of entries in a page (default is 50)","format":"int32","default":50}},{"name":"sort","in":"query","description":"The query parameter sort allows to define the sort order for the result of a query. A sort criteria\nconsists of the name of a field and the sort direction (ASC for ascending and DESC descending).\nThe sequence of the sort criteria (multiple can be used) defines the sort order of the entities\nin the result.","required":false,"schema":{"type":"string","description":"The query parameter sort allows to define the sort order for the result of a query. A sort criteria\nconsists of the name of a field and the sort direction (ASC for ascending and DESC descending).\nThe sequence of the sort criteria (multiple can be used) defines the sort order of the entities\nin the result."}},{"name":"q","in":"query","description":"Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for\navailable fields.","required":false,"schema":{"type":"string","description":"Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for\navailable fields."}},{"name":"representation","in":"query","description":"The representation mode. Can be \"full\" or \"compact\". Defaults to \"compact\"\n","required":false,"schema":{"type":"string","description":"The representation mode. Can be \"full\" or \"compact\". Defaults to \"compact\"\n","default":"compact"}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtAction"}},"application/json":{"schema":{"$ref":"#/components/schemas/PagedListMgmtAction"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/actions/{actionId}":{"get":{"tags":["Actions"],"summary":"Return action by id","description":"Handles the GET request of retrieving a single action by actionId.","operationId":"getAction_1","parameters":[{"name":"actionId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successfully retrieved","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/MgmtAction"}},"application/json":{"schema":{"$ref":"#/components/schemas/MgmtAction"}}}},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"404":{"description":"Target not found.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/targettypes/{targetTypeId}/compatibledistributionsettypes/{distributionSetTypeId}":{"delete":{"tags":["Target Types"],"summary":"Remove compatibility of distribution set type from the target type","description":"Handles the DELETE request for removing a distribution set type from a single target type. Required Permission: UPDATE_TARGET and READ_REPOSITORY","operationId":"removeCompatibleDistributionSet","parameters":[{"name":"targetTypeId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"distributionSetTypeId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successfully retrieved"},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Distribution set type was not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}},"/rest/v1/distributionsets/{distributionSetId}/assignedSM/{softwareModuleId}":{"delete":{"tags":["Distribution Sets"],"summary":"Delete the assignment of the software module from the distribution set","description":"Delete an assignment. Required permission: UPDATE_REPOSITORY","operationId":"deleteAssignSoftwareModules","parameters":[{"name":"distributionSetId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"softwareModuleId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successfully retrieved"},"400":{"description":"Bad Request - e.g. invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionInfo"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{}}},"403":{"description":"Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.","content":{"application/json":{}}},"404":{"description":"Distribution Set not found.","content":{"application/json":{}}},"405":{"description":"The http request method is not allowed on the resource.","content":{"application/json":{}}},"406":{"description":"In case accept header is specified and not application/json.","content":{"application/json":{}}},"429":{"description":"Too many requests. The server will refuse further attempts and the client has to wait another second.","content":{"application/json":{}}}}}}},"components":{"schemas":{"ExceptionInfo":{"type":"object","properties":{"exceptionClass":{"type":"string"},"errorCode":{"type":"string"},"message":{"type":"string"},"info":{"type":"object","additionalProperties":{"type":"object"}}}},"MgmtTargetTypeRequestBodyPut":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"The name of the entity","example":"updatedTypeName"},"description":{"type":"string","description":"The description of the entity","example":"an updated description"},"colour":{"type":"string","description":"The colour of the entity","example":"#aaafff"}}},"MgmtTargetType":{"required":["id","key","name"],"type":"object","properties":{"createdBy":{"type":"string","description":"Entity was originally created by (User, AMQP-Controller, anonymous etc.)","readOnly":true,"example":"bumlux"},"createdAt":{"type":"integer","description":"Entity was originally created at (timestamp UTC in milliseconds)","format":"int64","readOnly":true,"example":1691065905897},"lastModifiedBy":{"type":"string","description":"Entity was last modified by (User, AMQP-Controller, anonymous etc.)","readOnly":true,"example":"bumlux"},"lastModifiedAt":{"type":"integer","description":"Entity was last modified at (timestamp UTC in milliseconds)","format":"int64","readOnly":true,"example":1691065906407},"name":{"type":"string","example":"Name of entity"},"description":{"type":"string","example":"Description of entity"},"key":{"type":"string","description":"Key that can be interpreted by the target","example":"id.t23"},"colour":{"type":"string","description":"Colour assigned to the entity that could be used for representation purposes","example":"brown"},"deleted":{"type":"boolean","description":"Deleted flag, used for soft deleted entities","example":false},"id":{"type":"integer","description":"The technical identifier of the entity","format":"int64","example":26},"_links":{"$ref":"#/components/schemas/Links"}},"description":"**_links**:\n* **compatibledistributionsettypes** - Link to the compatible distribution set types in this target type\n","example":{"createdBy":"bumlux","createdAt":1682408564546,"lastModifiedBy":"bumlux","lastModifiedAt":1682408564546,"name":"TargetType","description":"TargetType description","colour":"#000000","_links":{"self":{"href":"https://management-api.host.com/rest/v1/targettypes/8"},"compatibledistributionsettypes":{"href":"https://management-api.host.com/rest/v1/targettypes/8/compatibledistributionsettypes"}},"id":8}},"MgmtTagRequestBodyPut":{"type":"object","properties":{"name":{"type":"string","description":"The name of the entity","example":"Example name"},"description":{"type":"string","description":"The description of the entity","example":"Example description"},"colour":{"type":"string","description":"The colour of the entity","example":"rgb(0,255,0)"}}},"MgmtTag":{"required":["id","name"],"type":"object","properties":{"createdBy":{"type":"string","description":"Entity was originally created by (User, AMQP-Controller, anonymous etc.)","readOnly":true,"example":"bumlux"},"createdAt":{"type":"integer","description":"Entity was originally created at (timestamp UTC in milliseconds)","format":"int64","readOnly":true,"example":1691065905897},"lastModifiedBy":{"type":"string","description":"Entity was last modified by (User, AMQP-Controller, anonymous etc.)","readOnly":true,"example":"bumlux"},"lastModifiedAt":{"type":"integer","description":"Entity was last modified at (timestamp UTC in milliseconds)","format":"int64","readOnly":true,"example":1691065906407},"name":{"type":"string","example":"Name of entity"},"description":{"type":"string","example":"Description of entity"},"id":{"type":"integer","description":"The technical identifier of the entity","format":"int64","example":2},"colour":{"type":"string","description":"The colour of the entity","example":"red"},"_links":{"$ref":"#/components/schemas/Links"}},"description":"**_links**:\n* **assignedDistributionSets** - Links to assigned distribution sets\n","example":{"createdBy":"bumlux","createdAt":1682408561990,"lastModifiedBy":"bumlux","lastModifiedAt":1682408561992,"name":"DsTag","description":"My name is DsTag","colour":"default","_links":{"self":{"href":"https://management-api.host.com/rest/v1/distributionsettags/6"},"assignedDistributionSets":{"href":"https://management-api.host.com/rest/v1/distributionsettags/6/assigned?offset=0&limit=50"}},"id":6}},"MgmtTargetRequestBody":{"required":["controllerId","name"],"type":"object","properties":{"name":{"type":"string","description":"The name of the entity","example":"controllerName"},"description":{"type":"string","description":"The description of the entity","example":"Example description of a target"},"controllerId":{"type":"string","description":"Controller ID","example":"123"},"address":{"type":"string","description":"The last known address URI of the target. Includes information of the target is connected either directly (DDI) through HTTP or indirectly (DMF) through amqp","example":"https://192.168.0.1"},"securityToken":{"type":"string","description":"Pre-Shared key that allows targets to authenticate at Direct Device Integration API if enabled in the tenant settings","example":"2345678DGGDGFTDzztgf"},"requestAttributes":{"type":"boolean","description":"Request re-transmission of target attributes","example":true},"targetType":{"type":"integer","description":"ID of the target type","format":"int64","example":10}}},"MgmtPollStatus":{"type":"object","properties":{"lastRequestAt":{"type":"integer","format":"int64","example":1691065941102},"nextExpectedRequestAt":{"type":"integer","format":"int64","example":1691109141102},"overdue":{"type":"boolean","example":false}},"description":"Poll status"},"MgmtTarget":{"required":["controllerId","name"],"type":"object","properties":{"createdBy":{"type":"string","description":"Entity was originally created by (User, AMQP-Controller, anonymous etc.)","readOnly":true,"example":"bumlux"},"createdAt":{"type":"integer","description":"Entity was originally created at (timestamp UTC in milliseconds)","format":"int64","readOnly":true,"example":1691065905897},"lastModifiedBy":{"type":"string","description":"Entity was last modified by (User, AMQP-Controller, anonymous etc.)","readOnly":true,"example":"bumlux"},"lastModifiedAt":{"type":"integer","description":"Entity was last modified at (timestamp UTC in milliseconds)","format":"int64","readOnly":true,"example":1691065906407},"name":{"type":"string","example":"Name of entity"},"description":{"type":"string","example":"Description of entity"},"controllerId":{"type":"string","description":"Controller ID","example":"123"},"updateStatus":{"type":"string","description":"If the target is in sync","example":"in_sync"},"lastControllerRequestAt":{"type":"integer","description":"Timestamp of the last controller request","format":"int64","example":1691065941102},"installedAt":{"type":"integer","description":"Install timestamp","format":"int64","example":1691065941155},"ipAddress":{"type":"string","description":"Last known IP address of the target. Only presented if IP address of the target itself is known (connected directly through DDI API)","example":"192.168.0.1"},"address":{"type":"string","description":"The last known address URI of the target. Includes information of the target is connected either directly (DDI) through HTTP or indirectly (DMF) through amqp.","example":"http://192.168.0.1"},"pollStatus":{"$ref":"#/components/schemas/MgmtPollStatus"},"securityToken":{"type":"string","description":"Pre-Shared key that allows targets to authenticate at Direct Device Integration API if enabled in the tenant settings","example":"38e6a19932b014040ba061795186514e"},"requestAttributes":{"type":"boolean","description":"Request re-transmission of target attributes","example":true},"targetType":{"type":"integer","description":"ID of the target type","format":"int64","example":19},"targetTypeName":{"type":"string","description":"Name of the target type","example":"defaultType"},"autoConfirmActive":{"type":"boolean","description":"Present if user consent flow active. Indicates if auto-confirm is active","example":false},"_links":{"$ref":"#/components/schemas/Links"}},"description":"**_links**:\n* **assignedDS** - Links to assigned distribution sets\n* **installedDS** - Links to installed distribution sets\n* **attributes** - Links to attributes of the target\n* **actions** - Links to actions of the target\n* **metadata** - List of metadata\n* **targetType** - The link to the target type\n* **autoConfirm** - The link to the detailed auto confirm state\n","example":{"createdBy":"bumlux","createdAt":1682408577979,"lastModifiedBy":"bumlux","lastModifiedAt":1682408577988,"name":"137","description":"My name is 137","controllerId":"137","updateStatus":"in_sync","lastControllerRequestAt":1682408577978,"installedAt":1682408577987,"ipAddress":"192.168.0.1","address":"http://192.168.0.1","pollStatus":{"lastRequestAt":1682408577978,"nextExpectedRequestAt":1682451777978,"overdue":false},"securityToken":"949f1c3487125467464a960d750373c1","requestAttributes":true,"targetType":13,"targetTypeName":"defaultType","autoConfirmActive":false,"_links":{"self":{"href":"https://management-api.host.com/rest/v1/targets/137"},"assignedDS":{"href":"https://management-api.host.com/rest/v1/targets/137/assignedDS"},"installedDS":{"href":"https://management-api.host.com/rest/v1/targets/137/installedDS"},"attributes":{"href":"https://management-api.host.com/rest/v1/targets/137/attributes"},"actions":{"href":"https://management-api.host.com/rest/v1/targets/137/actions?offset=0&limit=50&sort=id%3ADESC"},"metadata":{"href":"https://management-api.host.com/rest/v1/targets/137/metadata?offset=0&limit=50"},"targetType":{"href":"https://management-api.host.com/rest/v1/targettypes/13"},"autoConfirm":{"href":"https://management-api.host.com/rest/v1/targets/137/autoConfirm"}}}},"MgmtMetadataBodyPut":{"type":"object","properties":{"value":{"type":"string","example":"someValue"}}},"MgmtMetadata":{"required":["key"],"type":"object","properties":{"key":{"type":"string","description":"Metadata property key","example":"someKnownKey"},"value":{"type":"string","description":"Metadata property value","example":"someKnownKeyValue"}}},"MgmtActionRequestBodyPut":{"type":"object","properties":{"forceType":{"type":"string","enum":["soft","forced","timeforced","downloadonly"]}}},"MgmtAction":{"type":"object","properties":{"createdBy":{"type":"string","description":"Entity was originally created by (User, AMQP-Controller, anonymous etc.)","readOnly":true,"example":"bumlux"},"createdAt":{"type":"integer","description":"Entity was originally created at (timestamp UTC in milliseconds)","format":"int64","readOnly":true,"example":1691065905897},"lastModifiedBy":{"type":"string","description":"Entity was last modified by (User, AMQP-Controller, anonymous etc.)","readOnly":true,"example":"bumlux"},"lastModifiedAt":{"type":"integer","description":"Entity was last modified at (timestamp UTC in milliseconds)","format":"int64","readOnly":true,"example":1691065906407},"id":{"type":"integer","description":"ID of the action","format":"int64","example":7},"type":{"type":"string","description":"Type of action","example":"update"},"status":{"type":"string","description":"Status of action","example":"finished"},"detailStatus":{"type":"string","description":"Detailed status of action","example":"finished"},"forceTime":{"type":"integer","format":"int64","example":1691065903238},"forceType":{"type":"string","enum":["soft","forced","timeforced","downloadonly"]},"weight":{"type":"integer","description":"Weight of the action showing the importance of the update","format":"int32","example":600},"rollout":{"type":"integer","description":"The ID of the rollout this action was created for","format":"int64","example":1},"rolloutName":{"type":"string","description":"The name of the rollout this action was created for","example":"rollout"},"lastStatusCode":{"type":"integer","description":"(Optional) Code provided as part of the last status update that was sent by the device.","format":"int32","example":200},"externalRef":{"type":"string","description":"If created by external system this field contains the external reference for the action"},"_links":{"$ref":"#/components/schemas/Links"}},"example":{"createdBy":"bumlux","createdAt":1682408571231,"lastModifiedBy":"bumlux","lastModifiedAt":1682408571265,"type":"update","status":"finished","detailStatus":"finished","rollout":1,"rolloutName":"rollout","_links":{"self":{"href":"https://management-api.host.com/rest/v1/targets/target137/actions/1"},"target":{"href":"https://management-api.host.com/rest/v1/targets/target137","name":"target137"},"distributionset":{"href":"https://management-api.host.com/rest/v1/distributionsets/1","name":"DS:1.0"},"status":{"href":"https://management-api.host.com/rest/v1/targets/target137/actions/1/status?offset=0&limit=50&sort=id%3ADESC"},"rollout":{"href":"https://management-api.host.com/rest/v1/rollouts/1","name":"rollout"}},"id":1,"forceType":"forced"}},"MgmtActionConfirmationRequestBodyPut":{"required":["confirmation"],"type":"object","properties":{"confirmation":{"type":"string","description":"Action confirmation state","enum":["confirmed","denied"]},"code":{"type":"integer","description":"(Optional) Individual status code","format":"int32","example":200},"details":{"type":"array","description":"List of detailed message information","example":["Feedback message"],"items":{"type":"string","description":"List of detailed message information","example":"[\"Feedback message\"]"}}}},"MgmtTargetFilterQueryRequestBody":{"required":["name","query"],"type":"object","properties":{"name":{"type":"string","example":"filterName"},"query":{"type":"string","example":"controllerId==example-target-*"}}},"MgmtTargetFilterQuery":{"required":["id"],"type":"object","properties":{"createdBy":{"type":"string","description":"Entity was originally created by (User, AMQP-Controller, anonymous etc.)","readOnly":true,"example":"bumlux"},"createdAt":{"type":"integer","description":"Entity was originally created at (timestamp UTC in milliseconds)","format":"int64","readOnly":true,"example":1691065905897},"lastModifiedBy":{"type":"string","description":"Entity was last modified by (User, AMQP-Controller, anonymous etc.)","readOnly":true,"example":"bumlux"},"lastModifiedAt":{"type":"integer","description":"Entity was last modified at (timestamp UTC in milliseconds)","format":"int64","readOnly":true,"example":1691065906407},"id":{"type":"integer","description":"The technical identifier of the entity","format":"int64","example":2},"name":{"type":"string","description":"The name of the entity","example":"filterName"},"query":{"type":"string","description":"Target filter query expression","example":"name==*"},"autoAssignDistributionSet":{"type":"integer","format":"int64","example":15},"autoAssignActionType":{"type":"string","description":"Auto assign distribution set id","enum":["soft","forced","timeforced","downloadonly"]},"autoAssignWeight":{"type":"integer","description":"Weight of the resulting Actions","format":"int32","example":600},"confirmationRequired":{"type":"boolean","description":"(Available with user consent flow active) Defines, if the confirmation is required for an action. Confirmation is required per default.","example":false},"_links":{"$ref":"#/components/schemas/Links"}},"description":"**_links**:\n* **autoAssignDS** - Link to manage the auto assign distribution set\n","example":{"createdBy":"bumlux","createdAt":1682408566380,"lastModifiedBy":"bumlux","lastModifiedAt":1682408566385,"name":"filter1","query":"name==*","autoAssignDistributionSet":3,"autoAssignActionType":"forced","autoAssignWeight":null,"confirmationRequired":null,"_links":{"self":{"href":"https://management-api.host.com/rest/v1/targetfilters/5"},"autoAssignDS":{"href":"https://management-api.host.com/rest/v1/targetfilters/5/autoAssignDS"}},"id":5}},"MgmtSystemTenantConfigurationValue":{"type":"object","properties":{"value":{"type":"object","description":"Current value of of configuration parameter","example":true},"global":{"type":"boolean","description":"true - if the current value is the global configuration value, false - if there is a tenant specific value configured","example":true},"lastModifiedAt":{"type":"integer","description":"Entity was last modified at (timestamp UTC in milliseconds)","format":"int64","example":1623085150},"lastModifiedBy":{"type":"string","description":"Entity was last modified by (User, AMQP-Controller, anonymous etc.)","example":"example user"},"createdAt":{"type":"integer","description":"Entity was originally created at (timestamp UTC in milliseconds)","format":"int64","example":1523085150},"createdBy":{"type":"string","description":"Entity was originally created by (User, AMQP-Controller, anonymous etc.)","example":"example user"},"_links":{"$ref":"#/components/schemas/Links"}},"description":"**properties**:\n* **rollout.approval.enabled** - Boolean, The configuration key 'rollout.approval.enabled' defines if\napproval mode for Rollout Management is enabled.\n* **repository.actions.autoclose.enabled** - Boolean, The configuration key 'repository.actions.autoclose.enabled' defines if autoclose running actions with new Distribution Set assignment is enabled.\n* **user.confirmation.flow.enabled** - Boolean, The configuration key 'user.confirmation.flow.enabled' defines if confirmation is required when distribution set is assigned to target.\n* **authentication.gatewaytoken.enabled** - Boolean, The configuration key 'authentication.gatewaytoken.enabled' defines if the authentication mode 'gateway security token' is enabled.\n* **action.cleanup.enabled** - Boolean, The configuration key 'action.cleanup.enabled' defines if automatic cleanup of deployment actions is enabled.\n* **action.cleanup.auto.expiry** - Long, The configuration key 'action.cleanup.auto.expiry' defines the expiry time in milliseconds that needs to elapse before an action may be cleaned up.\n* **authentication.header.enabled** - Boolean, The configuration key 'authentication.header.enabled' defines if the authentication mode 'authority header' is enabled.\n* **maintenanceWindowPollCount** - Integer, The configuration key 'maintenanceWindowPollCount' defines the polling interval so that controller tries to poll at least these many times between the last polling and before start of maintenance window. The polling interval is bounded by configured pollingTime and minPollingTime. The polling interval is modified as per following scheme: pollingTime(@time=t) = (maintenanceWindowStartTime - t)/maintenanceWindowPollCount.\n* **authentication.targettoken.enabled** - Boolean, The configuration key 'authentication.targettoken.enabled' defines if the authentication mode 'target security token' is enabled.\n* **pollingTime** - String, The configuration key 'pollingTime' defines the time interval between two poll requests of a target.\n* **anonymous.download.enabled** - Boolean, The configuration key 'anonymous.download.enabled' defines if the anonymous download mode is enabled.\n* **authentication.header.authority** - String, The configuration key 'authentication.header.authority' defines the name of the 'authority header'.\n* **minPollingTime** - String, The configuration key 'minPollingTime' defines the smallest time interval permitted between two poll requests of a target.\n* **authentication.gatewaytoken.key** - String, The configuration key 'authentication.gatewaytoken.key' defines the key of the gateway security token.\n* **action.cleanup.auto.status** - String, The configuration key 'action.cleanup.auto.status' defines the list of action status that should be taken into account for the cleanup.\n* **pollingOverdueTime** - String, The configuration key 'pollingOverdueTime' defines the period of time after the SP server will recognize a target, which is not performing pull requests anymore.\n* **multi.assignments.enabled** - Boolean, The configuration key 'multi.assignments.enabled' defines if multiple distribution sets can be assigned to the same targets.\n* **batch.assignments.enabled** - Boolean, The configuration key 'batch.assignments.enabled' defines if distribution set can be assigned to multiple targets in a single batch message.\n* **implicit.lock.enabled** - Boolean (true by default), The configuration key 'implicit.lock.enabled' defines if distribution set and their software modules shall be implicitly locked when assigned to target, rollout or target filter.\n","example":{"value":"","global":true,"_links":{"self":{"href":"https://management-api.host.com/rest/v1/system/configs/authentication.gatewaytoken.key"}}}},"MgmtSystemTenantConfigurationValueRequest":{"required":["value"],"type":"object","properties":{"value":{"type":"object","description":"Current value of of configuration parameter","example":"exampleToken"}}},"MgmtSoftwareModuleTypeRequestBodyPut":{"type":"object","properties":{"description":{"type":"string","example":"Example description"},"colour":{"type":"string","example":"rgb(0,0,255"}}},"MgmtSoftwareModuleType":{"required":["id","key","name"],"type":"object","properties":{"createdBy":{"type":"string","description":"Entity was originally created by (User, AMQP-Controller, anonymous etc.)","readOnly":true,"example":"bumlux"},"createdAt":{"type":"integer","description":"Entity was originally created at (timestamp UTC in milliseconds)","format":"int64","readOnly":true,"example":1691065905897},"lastModifiedBy":{"type":"string","description":"Entity was last modified by (User, AMQP-Controller, anonymous etc.)","readOnly":true,"example":"bumlux"},"lastModifiedAt":{"type":"integer","description":"Entity was last modified at (timestamp UTC in milliseconds)","format":"int64","readOnly":true,"example":1691065906407},"name":{"type":"string","example":"Name of entity"},"description":{"type":"string","example":"Description of entity"},"key":{"type":"string","description":"Key that can be interpreted by the target","example":"id.t23"},"colour":{"type":"string","description":"Colour assigned to the entity that could be used for representation purposes","example":"brown"},"deleted":{"type":"boolean","description":"Deleted flag, used for soft deleted entities","example":false},"id":{"type":"integer","description":"The technical identifier of the entity","format":"int64","example":83},"maxAssignments":{"type":"integer","description":"Software modules of that type can be assigned at this maximum number (e.g. operating system only once)","format":"int32","example":1},"_links":{"$ref":"#/components/schemas/Links"}},"example":{"createdBy":"system","createdAt":1682408579390,"lastModifiedBy":"bumlux","lastModifiedAt":1682408579394,"name":"Application","description":"Updated description.","key":"application","maxAssignments":2147483647,"deleted":false,"_links":{"self":{"href":"https://management-api.host.com/rest/v1/softwaremoduletypes/4"}},"id":4}},"MgmtSoftwareModuleRequestBodyPut":{"type":"object","properties":{"description":{"type":"string","example":"SM Description"},"vendor":{"type":"string","example":"SM Vendor Name"},"locked":{"type":"boolean","description":"Should be set only if change of locked state is requested. If put, the software module locked flag will be\nset to the requested. Note: unlock (i.e. set this property to false) with extreme care!\nIn general once software module is locked it shall not be unlocked. Note that it could have been assigned /\ndeployed to targets.","example":true}}},"MgmtSoftwareModule":{"required":["id","name","type","version"],"type":"object","properties":{"createdBy":{"type":"string","description":"Entity was originally created by (User, AMQP-Controller, anonymous etc.)","readOnly":true,"example":"bumlux"},"createdAt":{"type":"integer","description":"Entity was originally created at (timestamp UTC in milliseconds)","format":"int64","readOnly":true,"example":1691065905897},"lastModifiedBy":{"type":"string","description":"Entity was last modified by (User, AMQP-Controller, anonymous etc.)","readOnly":true,"example":"bumlux"},"lastModifiedAt":{"type":"integer","description":"Entity was last modified at (timestamp UTC in milliseconds)","format":"int64","readOnly":true,"example":1691065906407},"name":{"type":"string","example":"Name of entity"},"description":{"type":"string","example":"Description of entity"},"id":{"type":"integer","description":"The technical identifier of the entity","format":"int64","example":6},"version":{"type":"string","description":"Package version","example":"1.0.0"},"type":{"type":"string","description":"The software module type of the entity","example":"os"},"typeName":{"type":"string","description":"The software module type name of the entity","example":"OS"},"vendor":{"type":"string","description":"The software vendor","example":"Vendor Limited, California"},"encrypted":{"type":"boolean","description":"If the software module is encrypted","example":false},"locked":{"type":"boolean","description":"If the software module is locked","example":true},"deleted":{"type":"boolean","description":"If the software module is deleted","example":false},"_links":{"$ref":"#/components/schemas/Links"}},"description":"**_links**:\n* **type** - The software module type of the entity\n* **artifacts** - List of artifacts of given software module\n* **metadata** - List of metadata\n","example":{"createdBy":"bumlux","createdAt":1682408572790,"lastModifiedBy":"bumlux","lastModifiedAt":1682408572791,"name":"os","description":"a description","version":"1.0","type":"os","typeName":"OS","vendor":"Vendor Limited, California","encrypted":false,"locked":true,"deleted":false,"_links":{"self":{"href":"https://management-api.host.com/rest/v1/softwaremodules/6"},"artifacts":{"href":"https://management-api.host.com/rest/v1/softwaremodules/6/artifacts"},"type":{"href":"https://management-api.host.com/rest/v1/softwaremoduletypes/13"},"metadata":{"href":"https://management-api.host.com/rest/v1/softwaremodules/6/metadata?offset=0&limit=50"}},"id":6}},"MgmtSoftwareModuleMetadataBodyPut":{"type":"object","properties":{"value":{"type":"string","example":"newValue"},"targetVisible":{"type":"boolean","example":true}}},"MgmtSoftwareModuleMetadata":{"required":["key"],"type":"object","properties":{"key":{"type":"string","description":"Metadata property key","example":"someKnownKey"},"value":{"type":"string","description":"Metadata property value","example":"someKnownValue"},"targetVisible":{"type":"boolean","description":"Metadata property is visible to targets as part of software update action","example":false}}},"MgmtRolloutRestRequestBodyPut":{"required":["name"],"type":"object","properties":{"createdBy":{"type":"string","description":"Entity was originally created by (User, AMQP-Controller, anonymous etc.)","readOnly":true,"example":"bumlux"},"createdAt":{"type":"integer","description":"Entity was originally created at (timestamp UTC in milliseconds)","format":"int64","readOnly":true,"example":1691065905897},"lastModifiedBy":{"type":"string","description":"Entity was last modified by (User, AMQP-Controller, anonymous etc.)","readOnly":true,"example":"bumlux"},"lastModifiedAt":{"type":"integer","description":"Entity was last modified at (timestamp UTC in milliseconds)","format":"int64","readOnly":true,"example":1691065906407},"name":{"type":"string","example":"Name of entity"},"description":{"type":"string","example":"Description of entity"},"_links":{"$ref":"#/components/schemas/Links"}},"example":{"name":"exampleRollout","description":"Rollout for all named targets"}},"MgmtRolloutResponseBody":{"required":["id","name","status","totalTargets"],"type":"object","properties":{"createdBy":{"type":"string","description":"Entity was originally created by (User, AMQP-Controller, anonymous etc.)","readOnly":true,"example":"bumlux"},"createdAt":{"type":"integer","description":"Entity was originally created at (timestamp UTC in milliseconds)","format":"int64","readOnly":true,"example":1691065905897},"lastModifiedBy":{"type":"string","description":"Entity was last modified by (User, AMQP-Controller, anonymous etc.)","readOnly":true,"example":"bumlux"},"lastModifiedAt":{"type":"integer","description":"Entity was last modified at (timestamp UTC in milliseconds)","format":"int64","readOnly":true,"example":1691065906407},"name":{"type":"string","example":"Name of entity"},"description":{"type":"string","example":"Description of entity"},"id":{"type":"integer","description":"Rollout id","format":"int64","example":2},"targetFilterQuery":{"type":"string","description":"Target filter query language expression","example":"controllerId==exampleTarget*"},"distributionSetId":{"type":"integer","description":"The ID of distribution set of this rollout","format":"int64","example":2},"status":{"type":"string","description":"The status of this rollout","example":"ready"},"totalTargets":{"type":"integer","description":"The total targets of a rollout","format":"int64","example":20},"totalTargetsPerStatus":{"type":"object","additionalProperties":{"type":"integer","description":"The total targets per status","format":"int64"},"description":"The total targets per status"},"totalGroups":{"type":"integer","description":"The total number of groups created by this rollout","format":"int32","example":5},"startAt":{"type":"integer","description":"Start at timestamp of Rollout","format":"int64","example":1691065753136},"forcetime":{"type":"integer","description":"Forcetime in milliseconds","format":"int64","example":1691065762496},"deleted":{"type":"boolean","description":"Deleted flag, used for soft deleted entities","example":false},"type":{"type":"string","description":"The type of this rollout","enum":["soft","forced","timeforced","downloadonly"]},"weight":{"type":"integer","description":"Weight of the resulting Actions","format":"int32","example":400},"dynamic":{"type":"boolean","description":"If this rollout is dynamic or static","example":true},"approvalRemark":{"type":"string","example":"Approved remark."},"approveDecidedBy":{"type":"string","example":"exampleUsername"},"_links":{"$ref":"#/components/schemas/Links"}},"description":"**_links**:\n* **start** - Link to start the rollout in sync mode\n* **pause** - Link to pause a running rollout\n* **triggerNextGroup** - Link for triggering next rollout group on a running rollout\n* **resume** - Link to resume a paused rollout\n* **groups** - Link to retrieve the groups a rollout\n* **approve** - Link to approve a rollout\n* **deny** - Link to deny a rollout\n* **distributionset** - The link to the distribution set\n","example":{"createdBy":"bumlux","createdAt":1682408568812,"lastModifiedBy":"bumlux","lastModifiedAt":1682408568812,"name":"exampleRollout","description":"Rollout for all named targets","targetFilterQuery":"id==targets-*","distributionSetId":6,"status":"creating","totalTargets":20,"totalTargetsPerStatus":{"running":0,"notstarted":20,"scheduled":0,"cancelled":0,"finished":0,"error":0},"totalGroups":5,"startAt":1682408570791,"forcetime":1682408571791,"deleted":false,"type":"forced","_links":{"start":{"href":"https://management-api.host.com/rest/v1/rollouts/6/start"},"pause":{"href":"https://management-api.host.com/rest/v1/rollouts/6/pause"},"resume":{"href":"https://management-api.host.com/rest/v1/rollouts/6/resume"},"triggerNextGroup":{"href":"https://management-api.host.com/rest/v1/rollouts/6/triggerNextGroup"},"approve":{"href":"https://management-api.host.com/rest/v1/rollouts/6/approve"},"deny":{"href":"https://management-api.host.com/rest/v1/rollouts/6/deny"},"groups":{"href":"https://management-api.host.com/rest/v1/rollouts/6/deploygroups?offset=0&limit=50"},"distributionset":{"href":"https://management-api.host.com/rest/v1/distributionsets/6","name":"bd3a71cb-6c8f-445c-adbb-e221414dcd96:1.0"},"self":{"href":"https://management-api.host.com/rest/v1/rollouts/6"}},"id":6}},"MgmtDistributionSetTypeRequestBodyPut":{"type":"object","properties":{"description":{"type":"string","description":"The description of the entity","example":"Example description"},"colour":{"type":"string","description":"The colour of the entity","example":"rgb(86,37,99)"}}},"MgmtDistributionSetType":{"required":["id","key","name"],"type":"object","properties":{"createdBy":{"type":"string","description":"Entity was originally created by (User, AMQP-Controller, anonymous etc.)","readOnly":true,"example":"bumlux"},"createdAt":{"type":"integer","description":"Entity was originally created at (timestamp UTC in milliseconds)","format":"int64","readOnly":true,"example":1691065905897},"lastModifiedBy":{"type":"string","description":"Entity was last modified by (User, AMQP-Controller, anonymous etc.)","readOnly":true,"example":"bumlux"},"lastModifiedAt":{"type":"integer","description":"Entity was last modified at (timestamp UTC in milliseconds)","format":"int64","readOnly":true,"example":1691065906407},"name":{"type":"string","example":"Name of entity"},"description":{"type":"string","example":"Description of entity"},"key":{"type":"string","description":"Key that can be interpreted by the target","example":"id.t23"},"colour":{"type":"string","description":"Colour assigned to the entity that could be used for representation purposes","example":"brown"},"deleted":{"type":"boolean","description":"Deleted flag, used for soft deleted entities","example":false},"id":{"type":"integer","description":"The technical identifier of the entity","format":"int64","example":99},"_links":{"$ref":"#/components/schemas/Links"}},"description":"**_links**:\n* **mandatorymodules** - Link to mandatory software modules types in this distribution set type\n* **optionalmodules** - Link to optional software modules types in this distribution set type\n","example":{"createdBy":"bumlux","createdAt":1682408579418,"lastModifiedBy":"bumlux","lastModifiedAt":1682408579459,"name":"OS (FW) mandatory, runtime (FW) and app (SW) optional","description":"Desc1234","key":"test_default_ds_type","deleted":false,"colour":"rgb(86,37,99)","_links":{"self":{"href":"https://management-api.host.com/rest/v1/distributionsettypes/14"},"mandatorymodules":{"href":"https://management-api.host.com/rest/v1/distributionsettypes/14/mandatorymoduletypes"},"optionalmodules":{"href":"https://management-api.host.com/rest/v1/distributionsettypes/14/optionalmoduletypes"}},"id":14}},"MgmtDistributionSetRequestBodyPut":{"type":"object","properties":{"name":{"type":"string","description":"The name of the entity","example":"dsOne"},"description":{"type":"string","description":"The description of the entity","example":"Description of the distribution set."},"version":{"type":"string","description":"Package version","example":"1.0.0"},"locked":{"type":"boolean","description":"Should be set only if change of locked state is requested. If put, the distribution set locked flag will be\nset to the requested. Note: unlock (i.e. set this property to false) with extreme care!\nIn general once distribution set is locked it shall not be unlocked. Note that it could have been assigned /\ndeployed to targets.","example":true},"requiredMigrationStep":{"type":"boolean","description":"True if DS is a required migration step for another DS. As a result the DS’s assignment will not be cancelled\nwhen another DS is assigned (note: updatable only if DS is not yet assigned to a target)","example":false}}},"MgmtDistributionSet":{"required":["id","name"],"type":"object","properties":{"createdBy":{"type":"string","description":"Entity was originally created by (User, AMQP-Controller, anonymous etc.)","readOnly":true,"example":"bumlux"},"createdAt":{"type":"integer","description":"Entity was originally created at (timestamp UTC in milliseconds)","format":"int64","readOnly":true,"example":1691065905897},"lastModifiedBy":{"type":"string","description":"Entity was last modified by (User, AMQP-Controller, anonymous etc.)","readOnly":true,"example":"bumlux"},"lastModifiedAt":{"type":"integer","description":"Entity was last modified at (timestamp UTC in milliseconds)","format":"int64","readOnly":true,"example":1691065906407},"name":{"type":"string","example":"Name of entity"},"description":{"type":"string","example":"Description of entity"},"id":{"type":"integer","description":"The technical identifier of the entity","format":"int64","example":51},"version":{"type":"string","description":"Package version","example":"1.4.2"},"type":{"type":"string","description":"The type of the distribution set","example":"test_default_ds_type"},"typeName":{"type":"string","description":"The type name of the distribution set","example":"OS (FW) mandatory, runtime (FW) and app (SW) optional"},"complete":{"type":"boolean","description":"True of the distribution set software module setup is complete as defined by the\ndistribution set type","example":true},"locked":{"type":"boolean","description":"If the distribution set is locked","example":true},"deleted":{"type":"boolean","description":"Deleted flag, used for soft deleted entities","example":false},"valid":{"type":"boolean","description":"True by default and false after the distribution set is invalidated by the user","example":true},"requiredMigrationStep":{"type":"boolean","description":"True if DS is a required migration step for another DS. As a result the DS’s assignment will not be cancelled\nwhen another DS is assigned (note: updatable only if DS is not yet assigned to a target)","example":false},"modules":{"type":"array","items":{"$ref":"#/components/schemas/MgmtSoftwareModule"}},"_links":{"$ref":"#/components/schemas/Links"}},"description":"**_links**:\n* **type** - The type of the distribution set\n* **modules** - List of software modules\n* **metadata** - List of metadata\n","example":{"createdBy":"bumlux","createdAt":1682408574924,"lastModifiedBy":"bumlux","lastModifiedAt":1682408574925,"name":"DS","description":"Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1","version":"1.0","modules":[{"createdBy":"bumlux","createdAt":1682408574921,"lastModifiedBy":"bumlux","lastModifiedAt":1682408574926,"name":"Firmware","description":"Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1","version":"1.0.42","type":"os","typeName":"OS","vendor":"vendor Limited Inc, California","locked":true,"deleted":false,"encrypted":false,"_links":{"self":{"href":"https://management-api.host.com/rest/v1/softwaremodules/18"}},"id":18},{"createdBy":"bumlux","createdAt":1682408574920,"lastModifiedBy":"bumlux","lastModifiedAt":1682408574925,"name":"app runtime","description":"Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1","version":"1.0.25","type":"runtime","typeName":"runtime","vendor":"vendor GmbH, Stuttgart, Germany","locked":true,"deleted":false,"encrypted":false,"_links":{"self":{"href":"https://management-api.host.com/rest/v1/softwaremodules/17"}},"id":17},{"createdBy":"bumlux","createdAt":1682408574919,"lastModifiedBy":"bumlux","lastModifiedAt":1682408574926,"name":"application","description":"Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1","version":"1.0.67","type":"application","typeName":"Application","vendor":"vendor Limited, California","locked":true,"deleted":false,"encrypted":false,"_links":{"self":{"href":"https://management-api.host.com/rest/v1/softwaremodules/16"}},"id":16}],"requiredMigrationStep":false,"type":"test_default_ds_type","typeName":"OS (FW) mandatory, runtime (FW) and app (SW) optional","complete":true,"deleted":false,"valid":true,"_links":{"self":{"href":"https://management-api.host.com/rest/v1/distributionsets/6"},"modules":{"href":"https://management-api.host.com/rest/v1/distributionsets/6/assignedSM?offset=0&limit=50"},"type":{"href":"https://management-api.host.com/rest/v1/distributionsettypes/24"},"metadata":{"href":"https://management-api.host.com/rest/v1/distributionsets/6/metadata?offset=0&limit=50"}},"id":6}},"MgmtDistributionSetTypeAssignment":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":108}},"description":"Array of distribution set types that are compatible to that target type"},"MgmtTargetTypeRequestBodyPost":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"The name of the entity","example":"updatedTypeName"},"description":{"type":"string","description":"The description of the entity","example":"an updated description"},"colour":{"type":"string","description":"The colour of the entity","example":"#aaafff"},"key":{"type":"string","description":"Target type key","example":"id.t23"},"compatibledistributionsettypes":{"type":"array","description":"Array of distribution set types that are compatible to that target type","items":{"$ref":"#/components/schemas/MgmtDistributionSetTypeAssignment"}}}},"MgmtId":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":108}}},"MgmtTargetAutoConfirmUpdate":{"type":"object","properties":{"initiator":{"type":"string","description":"(Optional) Initiator set on activation","example":"custom_initiator_value"},"remark":{"type":"string","description":"(Optional) Remark set on activation","example":"custom_remark"}}},"MgmtDistributionSetAssignment":{"required":["id"],"type":"object","properties":{"id":{"type":"integer","format":"int64","example":108},"forcetime":{"type":"integer","description":"Forcetime in milliseconds","format":"int64","example":1691065930359},"weight":{"type":"integer","description":"Importance of the assignment","format":"int32","example":23},"confirmationRequired":{"type":"boolean","description":"(Available with user consent flow active) Specifies if the confirmation by the device\nis required for this action","example":false},"type":{"type":"string","description":"The type of the assignment","enum":["soft","forced","timeforced","downloadonly"]},"maintenanceWindow":{"$ref":"#/components/schemas/MgmtMaintenanceWindowRequestBody"}}},"MgmtDistributionSetAssignments":{"type":"array","items":{"$ref":"#/components/schemas/MgmtDistributionSetAssignment"}},"MgmtMaintenanceWindowRequestBody":{"type":"object","properties":{"schedule":{"type":"string","description":"Schedule for the maintenance window start in quartz cron notation, such as '0 15 10 * * ? 2018'\nfor 10:15am every day during the year 2018","example":"10 12 14 3 8 ? 2023"},"duration":{"type":"string","description":"Duration of the window, such as '02:00:00' for 2 hours","example":"00:10:00"},"timezone":{"type":"string","description":"A time-zone offset from Greenwich/UTC, such as '+02:00'","example":"+00:00"}},"description":"Separation of download and install by defining a maintenance window for the installation"},"MgmtActionId":{"type":"object","properties":{"id":{"type":"integer","description":"ID of the action","format":"int64"},"_links":{"$ref":"#/components/schemas/Links"}},"description":"{\n \"id\" : 13,\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://management-api.host.com/rest/v1/targets/target2/actions/13\"\n }\n }\n}"},"MgmtTargetAssignmentResponseBody":{"type":"object","properties":{"alreadyAssigned":{"type":"integer","description":"Targets that had this distribution already assigned (in \"offline\" case this includes\ntargets that have arbitrary updates running)","format":"int32"},"assignedActions":{"type":"array","description":"The newly created actions as a result of this assignment","items":{"$ref":"#/components/schemas/MgmtActionId"}},"_links":{"$ref":"#/components/schemas/Links"},"assigned":{"type":"integer","description":"Targets that had this distribution set really assigned excluding already assigned","format":"int32"},"total":{"type":"integer","description":"Total targets","format":"int32"}}},"MgmtDistributionSetAutoAssignment":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":108},"type":{"type":"string","enum":["soft","forced","timeforced","downloadonly"]},"weight":{"type":"integer","format":"int32"},"confirmationRequired":{"type":"boolean"}}},"MgmtSoftwareModuleTypeRequestBodyPost":{"required":["key","name"],"type":"object","properties":{"description":{"type":"string","example":"Example description"},"colour":{"type":"string","example":"rgb(0,0,255"},"name":{"type":"string","example":"Example name"},"key":{"type":"string","example":"Example key"},"maxAssignments":{"type":"integer","format":"int32","example":1}}},"MgmtSoftwareModuleRequestBodyPost":{"required":["name","type","version"],"type":"object","properties":{"name":{"type":"string","example":"SM Name"},"version":{"type":"string","example":"1.0.0"},"type":{"type":"string","example":"os"},"description":{"type":"string","example":"SM Description"},"vendor":{"type":"string","example":"Vendor Limited, California"},"encrypted":{"type":"boolean","example":false}}},"MgmtArtifact":{"type":"object","properties":{"createdBy":{"type":"string","description":"Entity was originally created by (User, AMQP-Controller, anonymous etc.)","readOnly":true,"example":"bumlux"},"createdAt":{"type":"integer","description":"Entity was originally created at (timestamp UTC in milliseconds)","format":"int64","readOnly":true,"example":1691065905897},"lastModifiedBy":{"type":"string","description":"Entity was last modified by (User, AMQP-Controller, anonymous etc.)","readOnly":true,"example":"bumlux"},"lastModifiedAt":{"type":"integer","description":"Entity was last modified at (timestamp UTC in milliseconds)","format":"int64","readOnly":true,"example":1691065906407},"id":{"type":"integer","description":"Artifact id","format":"int64","example":3},"hashes":{"$ref":"#/components/schemas/MgmtArtifactHash"},"providedFilename":{"type":"string","example":"file1"},"size":{"type":"integer","description":"Size of the artifact","format":"int64","example":3},"_links":{"$ref":"#/components/schemas/Links"}},"description":"**_links**:\n* **download** - Download link of the artifact\n","example":{"createdBy":"bumlux","createdAt":1682408572660,"lastModifiedBy":"bumlux","lastModifiedAt":1682408572660,"hashes":{"sha1":"70686514bec4a9f8188f88d470fb3d7999728fad","md5":"f7c5b155e3636406cbc53c61f4692637","sha256":"efbbd71e3aa3c1db9ff3905c81f1220adb0e5db3c5438732eedf98ab006ca742"},"providedFilename":"origFilename","size":11,"_links":{"self":{"href":"https://management-api.host.com/rest/v1/softwaremodules/1/artifacts/1"},"download":{"href":"https://management-api.host.com/rest/v1/softwaremodules/1/artifacts/1/download"}},"id":1}},"MgmtArtifactHash":{"type":"object","properties":{"sha1":{"type":"string","description":"SHA1 hash of the artifact","example":"2d86c2a659e364e9abba49ea6ffcd53dd5559f05"},"md5":{"type":"string","description":"MD5 hash of the artifact.","example":"0d1b08c34858921bc7c662b228acb7ba"},"sha256":{"type":"string","description":"SHA256 hash of the artifact","example":"a03b221c6c6eae7122ca51695d456d5222e524889136394944b2f9763b483615"}}},"MgmtDynamicRolloutGroupTemplate":{"type":"object","properties":{"nameSuffix":{"type":"string","description":"The name suffix of the dynamic groups","example":"-dynamic"},"targetCount":{"type":"integer","description":"Count of targets a dynamic group shall include","format":"int64","example":20}},"description":"Template for dynamic groups (only if dynamic flag is true)"},"MgmtRolloutCondition":{"type":"object","properties":{"condition":{"type":"string","description":"The type of the condition","enum":["THRESHOLD"]},"expression":{"type":"string","description":"The expression according to the condition, e.g. the value of threshold in percentage","example":"50"}},"description":"The error condition which takes in place to evaluate if a rollout group encounter errors"},"MgmtRolloutErrorAction":{"type":"object","properties":{"action":{"type":"string","description":"The error action to execute","enum":["PAUSE"]},"expression":{"type":"string","description":"The expression for the error action","example":"80"}},"description":"The error action which is executed if the error condition is fulfilled"},"MgmtRolloutGroup":{"required":["name"],"type":"object","properties":{"createdBy":{"type":"string","description":"Entity was originally created by (User, AMQP-Controller, anonymous etc.)","readOnly":true,"example":"bumlux"},"createdAt":{"type":"integer","description":"Entity was originally created at (timestamp UTC in milliseconds)","format":"int64","readOnly":true,"example":1691065905897},"lastModifiedBy":{"type":"string","description":"Entity was last modified by (User, AMQP-Controller, anonymous etc.)","readOnly":true,"example":"bumlux"},"lastModifiedAt":{"type":"integer","description":"Entity was last modified at (timestamp UTC in milliseconds)","format":"int64","readOnly":true,"example":1691065906407},"name":{"type":"string","example":"Name of entity"},"description":{"type":"string","example":"Description of entity"},"successCondition":{"$ref":"#/components/schemas/MgmtRolloutCondition"},"successAction":{"$ref":"#/components/schemas/MgmtRolloutSuccessAction"},"errorCondition":{"$ref":"#/components/schemas/MgmtRolloutCondition"},"errorAction":{"$ref":"#/components/schemas/MgmtRolloutErrorAction"},"targetFilterQuery":{"type":"string","description":"The name of the entity","example":"controllerId==exampleTarget*"},"targetPercentage":{"type":"number","description":"Percentage of remaining and matching targets that should be added to this group","format":"float","example":20},"confirmationRequired":{"type":"boolean","description":"(Available with user consent flow active) If the confirmation is required for this rollout group. Confirmation is required per default","example":false},"_links":{"$ref":"#/components/schemas/Links"}},"description":"The list of group definitions"},"MgmtRolloutRestRequestBodyPost":{"required":["name"],"type":"object","properties":{"createdBy":{"type":"string","description":"Entity was originally created by (User, AMQP-Controller, anonymous etc.)","readOnly":true,"example":"bumlux"},"createdAt":{"type":"integer","description":"Entity was originally created at (timestamp UTC in milliseconds)","format":"int64","readOnly":true,"example":1691065905897},"lastModifiedBy":{"type":"string","description":"Entity was last modified by (User, AMQP-Controller, anonymous etc.)","readOnly":true,"example":"bumlux"},"lastModifiedAt":{"type":"integer","description":"Entity was last modified at (timestamp UTC in milliseconds)","format":"int64","readOnly":true,"example":1691065906407},"name":{"type":"string","example":"Name of entity"},"description":{"type":"string","example":"Description of entity"},"successCondition":{"$ref":"#/components/schemas/MgmtRolloutCondition"},"successAction":{"$ref":"#/components/schemas/MgmtRolloutSuccessAction"},"errorCondition":{"$ref":"#/components/schemas/MgmtRolloutCondition"},"errorAction":{"$ref":"#/components/schemas/MgmtRolloutErrorAction"},"targetFilterQuery":{"type":"string","description":"Target filter query language expression","example":"id==targets-*"},"distributionSetId":{"type":"integer","description":"The ID of distribution set of this rollout","format":"int64","example":6},"amountGroups":{"type":"integer","description":"The amount of groups the rollout should split targets into","format":"int32","example":5},"forcetime":{"type":"integer","description":"Force time in milliseconds","format":"int64","example":1691065781929},"startAt":{"type":"integer","description":"Start at timestamp of Rollout","format":"int64","example":1691065780929},"weight":{"type":"integer","description":"Weight of the resulting Actions","format":"int32","example":400},"dynamic":{"type":"boolean","example":true},"dynamicGroupTemplate":{"$ref":"#/components/schemas/MgmtDynamicRolloutGroupTemplate"},"confirmationRequired":{"type":"boolean","description":"(Available with user consent flow active) If the confirmation is required for this rollout. Value will be used\nif confirmation options are missing in the rollout group definitions. Confirmation is required per default","example":false},"type":{"type":"string","description":"The type of this rollout","enum":["soft","forced","timeforced","downloadonly"]},"groups":{"type":"array","description":"The list of group definitions","items":{"$ref":"#/components/schemas/MgmtRolloutGroup"}},"_links":{"$ref":"#/components/schemas/Links"}},"example":{"distributionSetId":6,"targetFilterQuery":"id==targets-*","description":"Rollout for all named targets","amountGroups":5,"type":"forced","successCondition":{"condition":"THRESHOLD","expression":"50"},"successAction":{"expression":"","action":"NEXTGROUP"},"name":"exampleRollout","forcetime":1682408571791,"errorAction":{"expression":"","action":"PAUSE"},"confirmationRequired":false,"errorCondition":{"condition":"THRESHOLD","expression":"80"},"startAt":1682408570791}},"MgmtRolloutSuccessAction":{"type":"object","properties":{"action":{"type":"string","description":"The success action to execute","enum":["NEXTGROUP"]},"expression":{"type":"string","description":"The expression for the success action"}},"description":"The success action which takes in place to execute in case the success action is fulfilled"},"MgmtDistributionSetTypeRequestBodyPost":{"required":["key","name"],"type":"object","properties":{"description":{"type":"string","description":"The description of the entity","example":"Example description"},"colour":{"type":"string","description":"The colour of the entity","example":"rgb(86,37,99)"},"name":{"type":"string","description":"The name of the entity","example":"Example type name"},"key":{"type":"string","description":"Functional key of the distribution set type","example":"Example key"},"mandatorymodules":{"type":"array","description":"Mandatory module type IDs","items":{"$ref":"#/components/schemas/MgmtSoftwareModuleTypeAssignment"}},"optionalmodules":{"type":"array","description":"Optional module type IDs","items":{"$ref":"#/components/schemas/MgmtSoftwareModuleTypeAssignment"}}}},"MgmtSoftwareModuleTypeAssignment":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":108}},"description":"Optional module type IDs"},"MgmtDistributionSetRequestBodyPost":{"type":"object","properties":{"name":{"type":"string","description":"The name of the entity","example":"dsOne"},"description":{"type":"string","description":"The description of the entity","example":"Description of the distribution set."},"version":{"type":"string","description":"Package version","example":"1.0.0"},"locked":{"type":"boolean","description":"Should be set only if change of locked state is requested. If put, the distribution set locked flag will be\nset to the requested. Note: unlock (i.e. set this property to false) with extreme care!\nIn general once distribution set is locked it shall not be unlocked. Note that it could have been assigned /\ndeployed to targets.","example":true},"requiredMigrationStep":{"type":"boolean","description":"True if DS is a required migration step for another DS. As a result the DS’s assignment will not be cancelled\nwhen another DS is assigned (note: updatable only if DS is not yet assigned to a target)","example":false},"modules":{"type":"array","items":{"$ref":"#/components/schemas/MgmtSoftwareModuleAssignment"}},"type":{"type":"string","description":"The type of the distribution set","example":"test_default_ds_type"}}},"MgmtSoftwareModuleAssignment":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":108}}},"MgmtInvalidateDistributionSetRequestBody":{"required":["actionCancelationType"],"type":"object","properties":{"actionCancelationType":{"type":"string","description":"Type of cancelation for actions referring to the given distribution set","enum":["soft","force","none"]},"cancelRollouts":{"type":"boolean","description":"Defines if rollouts referring to this distribution set should be canceled","example":true}}},"MgmtTargetAssignmentRequestBody":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The technical identifier of the entity","example":"target4"},"forcetime":{"type":"integer","description":"Forcetime in milliseconds","format":"int64","example":1682408575278},"type":{"type":"string","description":"The type of the assignment","enum":["soft","forced","timeforced","downloadonly"]},"maintenanceWindow":{"$ref":"#/components/schemas/MgmtMaintenanceWindowRequestBody"},"weight":{"type":"integer","description":"Importance of the assignment","format":"int32","example":100},"confirmationRequired":{"type":"boolean","description":"(Available with user consent flow active) Defines, if the confirmation is required for an action. Confirmation is required per default"}}},"MgmtUserInfo":{"type":"object","properties":{"tenant":{"type":"string"},"username":{"type":"string"}}},"PagedListMgmtTargetType":{"required":["content"],"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/MgmtTargetType"}},"total":{"type":"integer","format":"int64"},"size":{"type":"integer","format":"int32"},"_links":{"$ref":"#/components/schemas/Links"}}},"PagedListMgmtTag":{"required":["content"],"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/MgmtTag"}},"total":{"type":"integer","format":"int64"},"size":{"type":"integer","format":"int32"},"_links":{"$ref":"#/components/schemas/Links"}}},"PagedListMgmtTarget":{"required":["content"],"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/MgmtTarget"}},"total":{"type":"integer","format":"int64"},"size":{"type":"integer","format":"int32"},"_links":{"$ref":"#/components/schemas/Links"}}},"PagedListMgmtMetadata":{"required":["content"],"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/MgmtMetadata"}},"total":{"type":"integer","format":"int64"},"size":{"type":"integer","format":"int32"},"_links":{"$ref":"#/components/schemas/Links"}}},"MgmtTargetAutoConfirm":{"required":["active"],"type":"object","properties":{"active":{"type":"boolean","description":"Flag if auto confirm is active","example":true},"initiator":{"type":"string","description":"Initiator set on activation","example":"custom_initiator_value"},"remark":{"type":"string","description":"Remark set on activation","example":"custom_remark"},"activatedAt":{"type":"integer","description":"Timestamp of the activation","format":"int64","example":1691065938576},"_links":{"$ref":"#/components/schemas/Links"}},"description":"**_links**:\n* **deactivate** - Reference link to deactivate auto confirm (present if active)\n","example":{"active":true,"initiator":"custom_initiator_value","remark":"custom_remark","activatedAt":1682408577704,"_links":{"deactivate":{"href":"https://management-api.host.com/rest/v1/targets/137/autoConfirm/deactivate"}}}},"MgmtTargetAttributes":{"type":"object","additionalProperties":{"type":"string"}},"PagedListMgmtAction":{"required":["content"],"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/MgmtAction"}},"total":{"type":"integer","format":"int64"},"size":{"type":"integer","format":"int32"},"_links":{"$ref":"#/components/schemas/Links"}}},"MgmtActionStatus":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":21},"type":{"type":"string","example":"running"},"messages":{"type":"array","items":{"type":"string"}},"reportedAt":{"type":"integer","format":"int64","example":1691065929524},"timestamp":{"type":"integer","format":"int64","example":1691065929524},"code":{"type":"integer","format":"int32","example":200}}},"PagedListMgmtActionStatus":{"required":["content"],"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/MgmtActionStatus"}},"total":{"type":"integer","format":"int64"},"size":{"type":"integer","format":"int32"},"_links":{"$ref":"#/components/schemas/Links"}}},"PagedListMgmtTargetFilterQuery":{"required":["content"],"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/MgmtTargetFilterQuery"}},"total":{"type":"integer","format":"int64"},"size":{"type":"integer","format":"int32"},"_links":{"$ref":"#/components/schemas/Links"}}},"PagedListMgmtSoftwareModuleType":{"required":["content"],"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/MgmtSoftwareModuleType"}},"total":{"type":"integer","format":"int64"},"size":{"type":"integer","format":"int32"},"_links":{"$ref":"#/components/schemas/Links"}}},"PagedListMgmtSoftwareModule":{"required":["content"],"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/MgmtSoftwareModule"}},"total":{"type":"integer","format":"int64"},"size":{"type":"integer","format":"int32"},"_links":{"$ref":"#/components/schemas/Links"}}},"PagedListMgmtSoftwareModuleMetadata":{"required":["content"],"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/MgmtSoftwareModuleMetadata"}},"total":{"type":"integer","format":"int64"},"size":{"type":"integer","format":"int32"},"_links":{"$ref":"#/components/schemas/Links"}}},"PagedListMgmtRolloutResponseBody":{"required":["content"],"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/MgmtRolloutResponseBody"}},"total":{"type":"integer","format":"int64"},"size":{"type":"integer","format":"int32"},"_links":{"$ref":"#/components/schemas/Links"}}},"MgmtRolloutGroupResponseBody":{"required":["id","name"],"type":"object","properties":{"createdBy":{"type":"string","description":"Entity was originally created by (User, AMQP-Controller, anonymous etc.)","readOnly":true,"example":"bumlux"},"createdAt":{"type":"integer","description":"Entity was originally created at (timestamp UTC in milliseconds)","format":"int64","readOnly":true,"example":1691065905897},"lastModifiedBy":{"type":"string","description":"Entity was last modified by (User, AMQP-Controller, anonymous etc.)","readOnly":true,"example":"bumlux"},"lastModifiedAt":{"type":"integer","description":"Entity was last modified at (timestamp UTC in milliseconds)","format":"int64","readOnly":true,"example":1691065906407},"name":{"type":"string","example":"Name of entity"},"description":{"type":"string","example":"Description of entity"},"successCondition":{"$ref":"#/components/schemas/MgmtRolloutCondition"},"successAction":{"$ref":"#/components/schemas/MgmtRolloutSuccessAction"},"errorCondition":{"$ref":"#/components/schemas/MgmtRolloutCondition"},"errorAction":{"$ref":"#/components/schemas/MgmtRolloutErrorAction"},"targetFilterQuery":{"type":"string","description":"The name of the entity","example":"controllerId==exampleTarget*"},"targetPercentage":{"type":"number","description":"Percentage of remaining and matching targets that should be added to this group","format":"float","example":20},"confirmationRequired":{"type":"boolean","description":"(Available with user consent flow active) If the confirmation is required for this rollout group. Confirmation is required per default","example":false},"id":{"type":"integer","description":"Rollouts id","format":"int64","example":63},"dynamic":{"type":"boolean","description":"If the rollout group is dynamic","example":false},"status":{"type":"string","description":"The status of this rollout","example":"ready"},"totalTargets":{"type":"integer","description":"The total targets of a rollout","format":"int32","example":4},"totalTargetsPerStatus":{"type":"object","additionalProperties":{"type":"integer","description":"The total targets per status","format":"int64"},"description":"The total targets per status"},"_links":{"$ref":"#/components/schemas/Links"}},"example":{"createdBy":"bumlux","createdAt":1682408569768,"lastModifiedBy":"bumlux","lastModifiedAt":1682408569795,"name":"group-1","description":"group-1","successCondition":{"condition":"THRESHOLD","expression":"10"},"successAction":{"action":"NEXTGROUP","expression":""},"errorCondition":{"condition":"THRESHOLD","expression":"50"},"errorAction":{"action":"PAUSE","expression":""},"targetFilterQuery":"","targetPercentage":20,"confirmationRequired":false,"status":"ready","totalTargets":4,"totalTargetsPerStatus":{"running":0,"notstarted":4,"scheduled":0,"cancelled":0,"finished":0,"error":0},"_links":{"self":{"href":"https://management-api.host.com/rest/v1/rollouts/17/deploygroups/78"}},"id":78}},"PagedListMgmtRolloutGroupResponseBody":{"required":["content"],"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/MgmtRolloutGroupResponseBody"}},"total":{"type":"integer","format":"int64"},"size":{"type":"integer","format":"int32"},"_links":{"$ref":"#/components/schemas/Links"}}},"PagedListMgmtDistributionSetType":{"required":["content"],"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/MgmtDistributionSetType"}},"total":{"type":"integer","format":"int64"},"size":{"type":"integer","format":"int32"},"_links":{"$ref":"#/components/schemas/Links"}}},"PagedListMgmtDistributionSet":{"required":["content"],"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/MgmtDistributionSet"}},"total":{"type":"integer","format":"int64"},"size":{"type":"integer","format":"int32"},"_links":{"$ref":"#/components/schemas/Links"}}},"MgmtDistributionSetStatistics":{"type":"object","properties":{"actions":{"type":"object","additionalProperties":{"type":"integer","format":"int64"}},"rollouts":{"type":"object","additionalProperties":{"type":"integer","format":"int64"}},"totalAutoAssignments":{"type":"integer","format":"int64"}}},"Link":{"type":"object","properties":{"href":{"type":"string"},"hreflang":{"type":"string"},"title":{"type":"string"},"type":{"type":"string"},"deprecation":{"type":"string"},"profile":{"type":"string"},"name":{"type":"string"},"templated":{"type":"boolean"}}},"Links":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Link"}}}}}},"searchIndex":{"store":["tag/Distribution-Sets","tag/Distribution-Sets/operation/getDistributionSet","tag/Distribution-Sets/operation/updateDistributionSet","tag/Distribution-Sets/operation/deleteDistributionSet","tag/Distribution-Sets/operation/getMetadataValue_2","tag/Distribution-Sets/operation/updateMetadata_2","tag/Distribution-Sets/operation/deleteMetadata_2","tag/Distribution-Sets/operation/getDistributionSets","tag/Distribution-Sets/operation/createDistributionSets","tag/Distribution-Sets/operation/getMetadata_2","tag/Distribution-Sets/operation/createMetadata_2","tag/Distribution-Sets/operation/invalidateDistributionSet","tag/Distribution-Sets/operation/getAssignedTargets_1","tag/Distribution-Sets/operation/createAssignedTarget","tag/Distribution-Sets/operation/getAssignedSoftwareModules","tag/Distribution-Sets/operation/assignSoftwareModules","tag/Distribution-Sets/operation/getStatisticsForDistributionSet","tag/Distribution-Sets/operation/getRolloutsCountByStatusForDistributionSet","tag/Distribution-Sets/operation/getAutoAssignmentsCountForDistributionSet","tag/Distribution-Sets/operation/getActionsCountByStatusForDistributionSet","tag/Distribution-Sets/operation/getInstalledTargets","tag/Distribution-Sets/operation/getAutoAssignTargetFilterQueries","tag/Distribution-Sets/operation/deleteAssignSoftwareModules","tag/Targets","tag/Targets/operation/getTarget","tag/Targets/operation/updateTarget","tag/Targets/operation/deleteTarget","tag/Targets/operation/getMetadataValue","tag/Targets/operation/updateMetadata","tag/Targets/operation/deleteMetadata","tag/Targets/operation/getAction","tag/Targets/operation/updateAction","tag/Targets/operation/cancelAction","tag/Targets/operation/updateActionConfirmation","tag/Targets/operation/getTargets","tag/Targets/operation/createTargets","tag/Targets/operation/assignTargetType","tag/Targets/operation/unassignTargetType","tag/Targets/operation/getMetadata","tag/Targets/operation/createMetadata","tag/Targets/operation/deactivateAutoConfirm","tag/Targets/operation/activateAutoConfirm","tag/Targets/operation/getAssignedDistributionSet","tag/Targets/operation/postAssignedDistributionSet","tag/Targets/operation/getTags","tag/Targets/operation/getInstalledDistributionSet","tag/Targets/operation/getAutoConfirmStatus","tag/Targets/operation/getAttributes","tag/Targets/operation/getActionHistory","tag/Targets/operation/getActionStatusList","tag/Actions","tag/Actions/operation/getActions","tag/Actions/operation/getAction_1","tag/Basic-Authentication","tag/Basic-Authentication/operation/validateBasicAuth","tag/Software-Module-Types","tag/Software-Module-Types/operation/getSoftwareModuleType","tag/Software-Module-Types/operation/updateSoftwareModuleType","tag/Software-Module-Types/operation/deleteSoftwareModuleType","tag/Software-Module-Types/operation/getTypes","tag/Software-Module-Types/operation/createSoftwareModuleTypes","tag/Rollouts","tag/Rollouts/operation/getRollout","tag/Rollouts/operation/update","tag/Rollouts/operation/delete","tag/Rollouts/operation/getRollouts","tag/Rollouts/operation/create","tag/Rollouts/operation/triggerNextGroup","tag/Rollouts/operation/start","tag/Rollouts/operation/retryRollout","tag/Rollouts/operation/resume","tag/Rollouts/operation/pause","tag/Rollouts/operation/deny","tag/Rollouts/operation/approve","tag/Rollouts/operation/getRolloutGroups","tag/Rollouts/operation/getRolloutGroup","tag/Rollouts/operation/getRolloutGroupTargets","tag/Target-Types","tag/Target-Types/operation/getTargetType","tag/Target-Types/operation/updateTargetType","tag/Target-Types/operation/deleteTargetType","tag/Target-Types/operation/getTargetTypes","tag/Target-Types/operation/createTargetTypes","tag/Target-Types/operation/getCompatibleDistributionSets","tag/Target-Types/operation/addCompatibleDistributionSets","tag/Target-Types/operation/removeCompatibleDistributionSet","tag/Software-Modules","tag/Software-Modules/operation/getSoftwareModule","tag/Software-Modules/operation/updateSoftwareModule","tag/Software-Modules/operation/deleteSoftwareModule","tag/Software-Modules/operation/getMetadataValue_1","tag/Software-Modules/operation/updateMetadata_1","tag/Software-Modules/operation/deleteMetadata_1","tag/Software-Modules/operation/getSoftwareModules","tag/Software-Modules/operation/createSoftwareModules","tag/Software-Modules/operation/getMetadata_1","tag/Software-Modules/operation/createMetadata_1","tag/Software-Modules/operation/getArtifacts","tag/Software-Modules/operation/uploadArtifact","tag/Software-Modules/operation/getArtifact","tag/Software-Modules/operation/deleteArtifact","tag/Target-Tags","tag/Target-Tags/operation/getTargetTag","tag/Target-Tags/operation/updateTargetTag","tag/Target-Tags/operation/deleteTargetTag","tag/Target-Tags/operation/getAssignedTargets","tag/Target-Tags/operation/assignTargets","tag/Target-Tags/operation/unassignTargets","tag/Target-Tags/operation/getTargetTags","tag/Target-Tags/operation/createTargetTags","tag/Target-Tags/operation/assignTarget","tag/Target-Tags/operation/unassignTarget","tag/Target-Filter-Queries","tag/Target-Filter-Queries/operation/getFilter","tag/Target-Filter-Queries/operation/updateFilter","tag/Target-Filter-Queries/operation/deleteFilter","tag/Target-Filter-Queries/operation/getFilters","tag/Target-Filter-Queries/operation/createFilter","tag/Target-Filter-Queries/operation/getAssignedDistributionSet_1","tag/Target-Filter-Queries/operation/postAssignedDistributionSet_1","tag/Target-Filter-Queries/operation/deleteAssignedDistributionSet","tag/Download-artifact","tag/Download-artifact/operation/downloadArtifact_1","tag/Distribution-Set-Tags","tag/Distribution-Set-Tags/operation/getDistributionSetTag","tag/Distribution-Set-Tags/operation/updateDistributionSetTag","tag/Distribution-Set-Tags/operation/deleteDistributionSetTag","tag/Distribution-Set-Tags/operation/getAssignedDistributionSets","tag/Distribution-Set-Tags/operation/assignDistributionSetsPut","tag/Distribution-Set-Tags/operation/assignDistributionSets","tag/Distribution-Set-Tags/operation/unassignDistributionSets","tag/Distribution-Set-Tags/operation/getDistributionSetTags","tag/Distribution-Set-Tags/operation/createDistributionSetTags","tag/Distribution-Set-Tags/operation/assignDistributionSet","tag/Distribution-Set-Tags/operation/unassignDistributionSet","tag/Distribution-Set-Types","tag/Distribution-Set-Types/operation/getDistributionSetType","tag/Distribution-Set-Types/operation/updateDistributionSetType","tag/Distribution-Set-Types/operation/deleteDistributionSetType","tag/Distribution-Set-Types/operation/getDistributionSetTypes","tag/Distribution-Set-Types/operation/createDistributionSetTypes","tag/Distribution-Set-Types/operation/getOptionalModules","tag/Distribution-Set-Types/operation/addOptionalModule","tag/Distribution-Set-Types/operation/getMandatoryModules","tag/Distribution-Set-Types/operation/addMandatoryModule","tag/Distribution-Set-Types/operation/getOptionalModule","tag/Distribution-Set-Types/operation/removeOptionalModule","tag/Distribution-Set-Types/operation/getMandatoryModule","tag/Distribution-Set-Types/operation/removeMandatoryModule","tag/System-Configuration","tag/System-Configuration/operation/getTenantConfiguration","tag/System-Configuration/operation/updateTenantConfiguration","tag/System-Configuration/operation/getTenantConfigurationValue","tag/System-Configuration/operation/updateTenantConfigurationValue","tag/System-Configuration/operation/deleteTenantConfigurationValue"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,0.494,1,0.569]],["description/0",[2,3.091,3,4.65,4,0.379,5,5.688,6,3.305,7,3.193]],["title/1",[0,0.4,1,0.46,8,0.974,9,0.893]],["description/1",[0,0.395,1,0.455,4,0.32,9,0.882,10,0.311,11,1.208,12,0.357,13,0.357,14,1.447,15,3.927]],["title/2",[0,0.442,1,0.509,16,2.051]],["description/2",[0,0.395,1,0.455,4,0.32,9,0.882,10,0.311,12,0.357,13,0.357,15,3.927,16,1.833,17,2.262]],["title/3",[0,0.4,1,0.46,18,1.361,19,1.817]],["description/3",[0,0.395,1,0.455,4,0.32,9,0.882,10,0.311,12,0.357,13,0.357,15,3.927,18,1.345,20,3.287]],["title/4",[0,0.271,1,0.312,8,0.66,9,0.604,21,1.913,22,1.913,23,1.474,24,0.889,25,1.789]],["description/4",[9,0.849,12,0.343,13,0.343,14,1.393,21,3.699,22,3.699,23,2.07,25,2.513,26,3.78]],["title/5",[0,0.311,1,0.358,9,0.694,16,1.443,21,2.196,22,2.196,23,1.692]],["description/5",[9,0.849,12,0.343,13,0.343,16,1.765,17,2.178,21,2.686,22,2.686,23,2.07,25,2.513,26,3.78,27,3.78]],["title/6",[0,0.311,1,0.358,9,0.694,18,1.058,21,2.196,22,2.196,28,2.587]],["description/6",[9,0.956,12,0.387,13,0.387,17,2.453,18,1.458,21,3.026,22,3.026,26,4.258]],["title/7",[0,0.442,1,0.509,8,1.077]],["description/7",[0,0.411,1,0.473,4,0.333,10,0.323,11,1.257,12,0.371,13,0.371,14,1.505,29,4.448]],["title/8",[0,0.4,1,0.46,30,1.743,31,2.417]],["description/8",[0,0.301,1,0.511,4,0.244,10,0.349,12,0.272,13,0.272,29,3.26,30,1.314,31,1.821,32,1.262,33,2.995,34,2.995,35,2.128,36,2.128,37,1.314,38,2.638]],["title/9",[0,0.365,1,0.42,8,0.89,21,2.579,22,2.579]],["description/9",[0,0.395,1,0.455,12,0.357,13,0.357,14,1.447,21,2.791,22,2.791,37,1.722,39,3.667,40,4.275]],["title/10",[0,0.311,1,0.358,21,2.196,22,2.196,24,1.021,30,1.356,37,1.356]],["description/10",[12,0.357,13,0.357,14,1.447,21,2.791,22,2.791,28,3.287,30,1.722,37,1.722,40,4.275,41,2.15]],["title/11",[0,0.442,1,0.509,42,4.783]],["description/11",[0,0.497,1,0.573,12,0.171,13,0.171,17,1.083,41,1.029,42,4.886,43,2.299,44,1.88,45,2.299,46,1.032,47,0.175,48,2.299,49,2.299,50,1.385,51,1.25,52,2.299,53,2.046,54,2.299,55,3.069,56,0.706,57,1.755,58,0.897,59,2.299,60,2.299]],["title/12",[0,0.336,1,0.387,8,0.818,24,1.103,46,1.123,47,0.311]],["description/12",[0,0.353,1,0.407,4,0.286,9,0.79,10,0.278,11,1.082,12,0.319,13,0.319,14,1.296,46,1.183,47,0.328,61,2.026,62,3.828]],["title/13",[0,0.336,1,0.387,9,0.75,46,1.123,47,0.311,63,3.117]],["description/13",[0,0.243,4,0.197,10,0.297,12,0.22,13,0.22,14,0.892,19,1.106,32,1.02,35,1.72,36,1.72,37,1.062,41,1.326,44,2.42,46,0.814,47,0.429,62,2.635,63,2.26,64,2.635,65,2.961,66,2.961,67,2.132,68,2.635,69,2.961]],["title/14",[0,0.311,1,0.358,8,0.758,24,1.021,46,1.039,70,1.039,71,1.003]],["description/14",[0,0.395,1,0.455,4,0.32,9,0.882,10,0.311,11,1.208,12,0.357,13,0.357,14,1.447,72,4.275]],["title/15",[0,0.336,1,0.387,37,1.464,46,1.123,70,1.123,71,1.083]],["description/15",[0,0.276,4,0.224,10,0.328,12,0.25,13,0.25,14,1.013,17,1.584,19,1.257,32,1.159,35,1.954,36,1.954,37,1.206,46,0.925,63,2.568,64,2.994,70,1.392,71,1.343,72,2.994]],["title/16",[0,0.271,1,0.312,8,0.66,46,0.905,51,1.789,56,1.01,58,1.284,73,2.062,74,2.151]],["description/16",[0,0.366,1,0.422,4,0.297,10,0.288,11,1.121,46,1.225,51,2.422,56,1.368,58,1.738,73,2.792,74,2.912,75,4.456]],["title/17",[0,0.336,1,0.387,8,0.818,56,1.253,73,2.558,74,2.668]],["description/17",[0,0.411,1,0.473,4,0.333,10,0.323,11,1.257,56,1.534,73,3.131,74,3.266,76,4.997]],["title/18",[0,0.336,1,0.387,8,0.818,46,1.123,51,2.219,73,2.558]],["description/18",[0,0.411,1,0.473,4,0.333,10,0.323,11,1.257,46,1.374,51,2.716,73,3.131,77,4.997]],["title/19",[0,0.336,1,0.387,8,0.818,58,1.592,73,2.558,74,2.668]],["description/19",[0,0.411,1,0.473,4,0.333,10,0.323,11,1.257,58,1.949,73,3.131,74,3.266,78,4.997]],["title/20",[0,0.336,1,0.387,8,0.818,24,1.103,47,0.311,79,3.117]],["description/20",[0,0.353,1,0.407,4,0.286,9,0.79,10,0.278,11,1.082,12,0.319,13,0.319,14,1.296,47,0.328,61,2.026,79,3.284,80,4.301]],["title/21",[0,0.254,1,0.293,8,0.62,46,0.85,47,0.236,51,1.681,81,1.384,82,1.537,83,1.582,84,2.361]],["description/21",[0,0.33,1,0.381,4,0.268,9,0.738,10,0.26,11,1.011,12,0.299,13,0.299,14,1.211,46,1.106,47,0.306,61,1.894,81,1.8,82,1.999,85,4.021]],["title/22",[0,0.336,1,0.387,18,1.143,46,1.123,70,1.123,71,1.083]],["description/22",[12,0.422,13,0.422,17,2.679,18,1.592,46,1.564,86,5.688]],["title/23",[47,0.519]],["description/23",[2,3.24,6,3.464,7,3.347,47,0.454,87,3.347]],["title/24",[8,1.077,19,2.008,47,0.41]],["description/24",[4,0.333,9,0.917,10,0.323,11,1.257,12,0.371,13,0.371,47,0.381,61,2.354,88,4.086]],["title/25",[16,2.051,19,2.008,47,0.41]],["description/25",[4,0.333,10,0.323,12,0.371,13,0.371,16,1.907,41,2.237,47,0.381,88,4.086,89,2.806]],["title/26",[18,1.505,19,2.008,47,0.41]],["description/26",[4,0.32,9,0.882,10,0.311,12,0.357,13,0.357,18,1.829,47,0.366,88,3.927,90,3.927]],["title/27",[8,0.758,9,0.694,23,1.692,24,1.021,25,2.054,47,0.288,91,1.507]],["description/27",[9,0.917,12,0.371,13,0.371,14,1.505,23,2.237,25,2.716,91,2.675,92,4.086]],["title/28",[9,0.815,16,1.694,23,1.987,47,0.338,91,1.769]],["description/28",[9,0.882,12,0.357,13,0.357,16,1.833,17,2.262,23,2.15,25,2.61,27,3.927,91,1.914,92,3.927]],["title/29",[9,0.815,18,1.243,28,3.037,47,0.338,91,1.769]],["description/29",[9,0.998,12,0.404,13,0.404,17,2.561,18,1.522,91,2.167,92,4.445]],["title/30",[8,0.89,19,1.659,24,1.199,47,0.338,58,1.731]],["description/30",[4,0.308,10,0.299,11,1.163,12,0.343,13,0.343,24,1.719,47,0.352,58,1.803,61,2.178,93,3.78]],["title/31",[57,3.712,58,1.896,94,4.327,95,4.327]],["description/31",[4,0.308,10,0.299,12,0.343,13,0.343,41,2.07,57,3.53,58,1.803,89,2.596,93,3.78,94,4.115,95,4.115]],["title/32",[24,1.313,47,0.37,55,3.975,58,1.896]],["description/32",[12,0.357,13,0.357,18,1.345,41,2.15,55,3.927,58,2.548,93,3.927,96,4.989]],["title/33",[58,1.731,97,4.438,98,4.438,99,3.95,100,3.388]],["description/33",[12,0.243,13,0.243,14,0.987,41,1.466,58,2.335,99,2.914,100,4.57,101,4.055,102,3.275,103,2.914,104,3.572,105,4.96,106,2.914,107,3.275,108,3.275]],["title/34",[8,1.204,47,0.458]],["description/34",[4,0.347,10,0.337,11,1.31,12,0.387,13,0.387,47,0.397,61,2.453,109,4.635]],["title/35",[30,2.154,110,4.911]],["description/35",[4,0.268,10,0.373,12,0.299,13,0.299,30,1.442,31,1.999,32,1.385,35,2.336,36,2.336,37,1.442,47,0.44,109,3.579,111,3.287]],["title/36",[46,1.337,47,0.502,112,0.992]],["description/36",[12,0.371,13,0.371,16,1.907,41,2.237,46,1.374,47,0.511,112,1.019,113,4.448]],["title/37",[47,0.502,112,0.992,114,2.929]],["description/37",[1,0.422,12,0.331,13,0.331,41,1.995,47,0.544,50,2.685,112,1.266,113,3.966,115,4.456]],["title/38",[8,0.974,24,1.313,47,0.37,91,1.938]],["description/38",[12,0.387,13,0.387,14,1.569,37,1.868,39,3.976,47,0.397,91,2.076,116,4.635]],["title/39",[24,1.199,30,1.592,37,1.592,47,0.338,91,1.769]],["description/39",[12,0.371,13,0.371,14,1.505,28,3.419,30,1.792,37,1.792,41,2.237,91,1.992,116,4.448]],["title/40",[24,1.313,47,0.37,117,4.327,118,3.502]],["description/40",[4,0.218,10,0.212,12,0.243,13,0.243,24,0.884,32,1.128,41,1.466,47,0.25,58,1.934,96,2.5,100,2.5,106,2.914,117,2.914,118,2.359,119,3.275,120,2.914,121,3.275,122,3.275,123,2.914,124,2.5,125,3.275]],["title/41",[24,1.313,47,0.37,96,3.712,118,3.502]],["description/41",[4,0.184,10,0.179,12,0.205,13,0.205,24,0.746,32,0.951,41,1.237,47,0.21,58,1.696,68,2.458,96,4.106,100,3.32,118,3.132,120,2.458,126,2.258,127,2.762,128,4.348,129,2.762,130,2.762,131,2.258,132,2.762,133,2.762,134,2.762]],["title/42",[0,0.336,1,0.387,8,0.818,24,1.103,46,1.123,47,0.311]],["description/42",[0,0.366,1,0.422,4,0.297,10,0.288,11,1.121,12,0.331,13,0.331,24,1.204,46,1.225,47,0.34,61,2.099,135,3.966]],["title/43",[0,0.365,1,0.42,24,1.199,46,1.22,47,0.338]],["description/43",[0,0.353,1,0.407,4,0.286,10,0.278,12,0.319,13,0.319,14,1.296,24,1.162,32,1.482,41,1.926,46,1.183,47,0.328,135,3.828]],["title/44",[8,0.974,24,1.313,47,0.37,136,1.708]],["description/44",[12,0.387,13,0.387,14,1.569,37,1.868,39,3.976,47,0.397,136,1.83,137,5.208]],["title/45",[0,0.336,1,0.387,8,0.818,24,1.103,47,0.311,79,3.117]],["description/45",[0,0.366,1,0.422,4,0.297,10,0.288,11,1.121,12,0.331,13,0.331,24,1.204,47,0.34,61,2.099,79,3.402,138,4.456]],["title/46",[8,0.818,24,1.103,47,0.311,104,2.941,126,3.338,139,4.083]],["description/46",[4,0.308,10,0.299,12,0.343,13,0.343,47,0.352,61,2.178,104,3.33,118,3.33,126,3.78,140,4.623,141,4.623]],["title/47",[8,0.974,24,1.313,47,0.37,142,4.327]],["description/47",[4,0.286,10,0.278,11,1.082,12,0.319,13,0.319,24,1.162,37,1.542,47,0.328,61,2.026,142,3.828,143,4.301,144,4.301,145,4.301]],["title/48",[8,0.974,24,1.313,47,0.37,58,1.896]],["description/48",[4,0.297,10,0.288,11,1.121,12,0.331,13,0.331,24,1.204,47,0.34,58,1.738,61,2.099,146,4.456,147,4.456,148,4.456]],["title/49",[8,0.818,24,1.576,47,0.311,58,1.592,74,2.668]],["description/49",[4,0.308,10,0.299,11,1.163,12,0.343,13,0.343,24,1.719,47,0.352,58,1.803,61,2.178,149,4.623]],["title/50",[58,2.656]],["description/50",[2,3.091,58,2.218,87,3.193,150,5.688,151,5.688,152,5.688]],["title/51",[8,1.204,58,2.343]],["description/51",[4,0.397,10,0.386,11,1.5,58,2.325,153,5.962]],["title/52",[8,1.077,19,2.008,58,2.096]],["description/52",[4,0.362,9,0.998,10,0.352,11,1.368,58,2.12,154,5.437,155,5.437]],["title/53",[156,5.347,157,6.007]],["description/53",[44,4.875,53,5.307,87,3.347,156,5.307,158,5.962]],["title/54",[159,6.81]],["description/54",[160,7.389]],["title/55",[70,1.478,71,1.426,112,1.096]],["description/55",[2,3.24,6,3.464,7,3.347,87,3.347,161,5.962]],["title/56",[8,0.89,9,0.815,70,1.22,71,1.177,112,0.905]],["description/56",[4,0.308,9,0.849,10,0.299,11,1.163,12,0.343,13,0.343,14,1.393,70,1.271,71,1.226,112,0.943,162,3.78]],["title/57",[16,1.856,70,1.337,71,1.29,112,0.992]],["description/57",[4,0.308,9,0.849,10,0.299,12,0.343,13,0.343,17,2.178,70,1.271,71,1.226,89,2.596,112,0.943,162,3.78]],["title/58",[18,1.243,19,1.659,70,1.22,71,1.177,112,0.905]],["description/58",[4,0.308,9,0.849,10,0.299,12,0.343,13,0.343,18,1.294,20,3.163,70,1.271,71,1.226,112,0.943,162,3.78]],["title/59",[8,0.974,70,1.337,71,1.29,112,0.992]],["description/59",[4,0.32,10,0.311,11,1.208,12,0.357,13,0.357,14,1.447,70,1.321,71,1.274,112,0.98,163,4.275]],["title/60",[30,1.592,31,2.207,70,1.22,71,1.177,112,0.905]],["description/60",[4,0.244,10,0.349,12,0.272,13,0.272,30,1.314,31,1.821,32,1.262,35,2.128,36,2.128,37,1.314,38,2.638,70,1.007,71,1.431,112,1.1,163,3.26]],["title/61",[56,2.09]],["description/61",[2,3.24,6,3.464,7,3.347,56,1.83,87,3.347]],["title/62",[8,1.077,9,0.987,56,1.649]],["description/62",[4,0.333,9,0.917,10,0.323,11,1.257,12,0.371,13,0.371,56,1.534,164,3.599,165,4.086]],["title/63",[16,2.293,56,1.844]],["description/63",[4,0.333,9,0.917,10,0.323,12,0.371,13,0.371,16,1.907,56,1.534,165,4.086,166,4.448]],["title/64",[18,1.682,56,1.844]],["description/64",[4,0.333,10,0.323,12,0.371,13,0.371,18,1.879,56,1.534,165,4.086,167,4.997]],["title/65",[8,1.204,56,1.844]],["description/65",[4,0.347,10,0.337,11,1.31,12,0.387,13,0.387,56,1.599,164,3.751,168,4.635]],["title/66",[30,1.927,31,2.672,56,1.649]],["description/66",[4,0.32,10,0.311,12,0.357,13,0.357,30,1.722,31,2.388,32,1.654,56,1.474,168,4.275,169,4.275]],["title/67",[56,1.253,57,3.117,123,3.634,131,3.338,170,3.634,171,2.558]],["description/67",[4,0.308,10,0.299,12,0.343,13,0.343,32,1.593,56,1.419,131,3.78,166,4.115,170,4.115,171,2.896,172,4.623]],["title/68",[56,1.844,173,5.347]],["description/68",[4,0.32,10,0.311,12,0.357,13,0.357,30,1.722,32,1.654,56,1.474,173,4.275,174,3.927,175,4.803]],["title/69",[56,1.844,176,5.347]],["description/69",[4,0.333,10,0.323,12,0.371,13,0.371,32,1.721,56,1.534,169,4.448,176,4.448,177,4.997]],["title/70",[56,1.844,178,5.347]],["description/70",[4,0.32,10,0.311,12,0.357,13,0.357,32,1.654,56,1.474,174,3.927,178,4.275,179,3.927,180,4.803]],["title/71",[56,1.844,179,4.911]],["description/71",[4,0.32,10,0.311,12,0.357,13,0.357,32,1.654,56,1.474,103,4.275,174,3.927,179,3.927,181,4.803]],["title/72",[56,1.844,101,4.911]],["description/72",[4,0.237,10,0.23,12,0.264,13,0.264,30,1.276,32,1.225,56,1.62,101,2.909,104,2.562,182,2.909,183,2.909,184,3.166,185,3.166,186,2.909,187,1.82,188,3.166,189,3.166,190,3.558]],["title/73",[56,1.844,183,4.911]],["description/73",[4,0.237,10,0.23,12,0.264,13,0.264,30,1.276,32,1.225,56,1.62,104,2.562,182,2.909,183,4.315,184,3.166,185,3.166,186,2.909,187,1.82,188,3.166,189,3.166,191,3.558]],["title/74",[8,0.89,56,1.899,171,2.781,192,4.438]],["description/74",[4,0.308,10,0.299,11,1.163,12,0.343,13,0.343,24,1.249,56,1.419,124,3.53,164,3.33,171,2.896,193,4.623]],["title/75",[8,0.974,9,0.893,56,1.492,171,3.046]],["description/75",[4,0.308,9,0.849,10,0.299,12,0.343,13,0.343,24,1.249,56,1.419,124,3.53,164,3.33,171,2.896,194,4.623]],["title/76",[8,0.818,24,1.103,47,0.311,56,1.253,171,2.558,195,3.634]],["description/76",[4,0.277,9,0.763,10,0.269,11,1.046,12,0.309,13,0.309,24,1.123,47,0.317,56,1.276,61,1.958,124,3.173,164,2.994,171,2.604,196,4.156]],["title/77",[47,0.458,112,1.225]],["description/77",[2,3.091,6,3.305,7,3.193,47,0.433,87,3.193,112,1.16]],["title/78",[8,0.974,19,1.817,47,0.37,112,0.992]],["description/78",[4,0.362,9,0.998,10,0.352,11,1.368,47,0.414,112,1.109,197,4.445]],["title/79",[16,1.856,19,1.817,47,0.37,112,0.992]],["description/79",[4,0.32,9,0.882,10,0.311,12,0.357,13,0.357,41,2.15,47,0.366,89,2.696,112,0.98,197,3.927]],["title/80",[18,1.361,19,1.817,47,0.37,112,0.992]],["description/80",[4,0.32,9,0.882,10,0.311,12,0.357,13,0.357,18,1.345,47,0.366,90,3.927,112,0.98,197,3.927]],["title/81",[8,1.077,47,0.41,112,1.096]],["description/81",[4,0.379,10,0.368,11,1.431,47,0.433,112,1.16,198,5.062]],["title/82",[30,1.927,47,0.41,112,1.096]],["description/82",[4,0.259,10,0.365,12,0.289,13,0.289,30,1.396,31,1.936,32,1.341,35,2.263,36,2.263,37,1.396,47,0.297,111,3.184,112,1.15,198,3.466]],["title/83",[0,0.336,1,0.387,8,0.818,37,1.464,112,0.833,199,2.941]],["description/83",[0,0.33,1,0.381,4,0.268,10,0.26,11,1.011,12,0.299,13,0.299,14,1.211,37,1.442,47,0.306,61,1.894,112,1.177,199,2.896,200,3.579]],["title/84",[0,0.311,1,0.358,47,0.288,112,1.125,199,2.723,201,2.886]],["description/84",[0,0.33,1,0.381,4,0.268,10,0.26,12,0.299,13,0.299,14,1.211,32,1.385,41,1.8,47,0.306,112,1.177,199,2.896,200,3.579,201,3.07]],["title/85",[0,0.311,1,0.358,47,0.288,50,2.278,112,1.125,199,2.723]],["description/85",[0,0.33,1,0.381,4,0.268,9,0.738,10,0.26,12,0.299,13,0.299,14,1.211,18,1.126,41,1.8,47,0.306,50,2.423,112,1.177,202,4.021]],["title/86",[70,1.652,71,1.594]],["description/86",[2,2.955,6,3.159,7,3.053,87,3.053,195,4.839,203,3.721,204,3.053]],["title/87",[8,0.974,19,1.817,70,1.337,71,1.29]],["description/87",[4,0.333,9,0.917,10,0.323,11,1.257,12,0.371,13,0.371,14,1.505,203,3.419,205,4.086]],["title/88",[16,2.051,70,1.478,71,1.426]],["description/88",[4,0.308,9,0.849,10,0.299,12,0.343,13,0.343,17,2.178,33,3.78,34,3.78,89,2.596,203,3.163,205,3.78]],["title/89",[18,1.361,19,1.817,70,1.337,71,1.29]],["description/89",[4,0.308,9,0.849,10,0.299,12,0.343,13,0.343,18,1.294,20,3.163,33,3.78,34,3.78,203,3.163,205,3.78]],["title/90",[8,0.705,9,0.646,23,1.576,24,0.95,25,1.913,70,0.968,71,0.934,91,1.403]],["description/90",[9,0.917,12,0.371,13,0.371,14,1.505,23,2.237,25,2.716,91,2.675,206,4.086]],["title/91",[9,0.75,16,1.558,23,1.828,70,1.123,71,1.083,91,1.627]],["description/91",[9,0.882,12,0.357,13,0.357,16,1.833,17,2.262,23,2.15,25,2.61,27,3.927,91,1.914,206,3.927]],["title/92",[9,0.75,18,1.143,28,2.794,70,1.123,71,1.083,91,1.627]],["description/92",[9,0.998,12,0.404,13,0.404,17,2.561,18,1.522,91,2.167,206,4.445]],["title/93",[8,1.077,70,1.478,71,1.426]],["description/93",[4,0.347,10,0.337,11,1.31,12,0.387,13,0.387,14,1.569,203,3.564,207,4.635]],["title/94",[30,1.927,70,1.478,208,5.374]],["description/94",[4,0.259,10,0.365,12,0.289,13,0.289,30,1.396,31,1.936,32,1.341,35,2.263,36,2.263,37,1.396,38,2.805,70,1.071,71,1.496,207,3.466]],["title/95",[8,0.974,70,1.337,71,1.29,91,1.938]],["description/95",[12,0.371,13,0.371,14,1.505,37,1.792,39,3.815,70,1.374,71,1.326,91,1.992,209,4.448]],["title/96",[24,1.103,30,1.464,37,1.464,70,1.123,71,1.083,91,1.627]],["description/96",[12,0.387,13,0.387,17,2.453,28,3.564,30,1.868,37,1.868,91,2.076,209,4.635]],["title/97",[8,0.818,46,1.123,70,1.123,71,1.083,91,1.627,204,2.292]],["description/97",[4,0.297,10,0.288,11,1.121,12,0.331,13,0.331,14,1.343,46,1.225,70,1.225,71,1.182,91,1.776,204,2.502,210,3.966]],["title/98",[204,3.373,211,5.347]],["description/98",[4,0.333,10,0.323,12,0.371,13,0.371,32,1.721,38,3.599,204,2.806,210,4.448,211,4.448]],["title/99",[8,0.974,9,0.893,91,1.938,204,2.729]],["description/99",[4,0.308,9,0.849,10,0.412,11,1.163,12,0.343,13,0.343,14,1.393,91,1.843,204,2.596,212,4.115]],["title/100",[18,1.505,19,2.008,204,3.017]],["description/100",[4,0.308,9,0.849,10,0.299,12,0.343,13,0.343,18,1.294,20,3.163,46,1.271,203,3.163,204,2.596,212,4.115]],["title/101",[47,0.458,136,2.111]],["description/101",[2,3.091,6,3.305,7,3.193,47,0.433,87,3.193,136,1.999]],["title/102",[8,0.974,19,1.817,47,0.37,136,1.708]],["description/102",[4,0.362,9,0.998,10,0.352,11,1.368,47,0.414,136,1.911,213,4.445]],["title/103",[16,1.856,19,1.817,47,0.37,136,1.708]],["description/103",[4,0.362,10,0.352,16,2.075,47,0.414,89,3.053,136,1.911,213,4.445]],["title/104",[18,1.361,19,1.817,47,0.37,136,1.708]],["description/104",[4,0.347,9,0.956,10,0.337,18,1.932,47,0.397,136,1.83,213,4.258]],["title/105",[8,0.974,46,1.337,47,0.37,136,1.708]],["description/105",[4,0.362,10,0.352,11,1.368,37,1.95,46,1.495,47,0.414,214,4.445]],["title/106",[46,1.337,83,2.487,110,3.975,215,3.712]],["description/106",[4,0.32,10,0.311,32,1.654,46,1.797,47,0.498,67,3.459,214,3.927,216,3.667]],["title/107",[47,0.37,83,2.487,114,2.929,215,3.712]],["description/107",[4,0.362,10,0.352,18,1.522,47,0.414,83,2.781,114,3.276,214,4.445]],["title/108",[8,1.077,47,0.41,136,1.889]],["description/108",[4,0.379,10,0.368,11,1.431,47,0.433,136,1.999,217,5.062]],["title/109",[30,1.927,47,0.41,218,5.374]],["description/109",[4,0.277,10,0.382,30,1.49,31,2.066,32,1.432,35,2.415,36,2.415,37,1.49,47,0.45,136,2.077,217,3.699]],["title/110",[46,1.337,83,2.487,110,3.975,215,3.712]],["description/110",[4,0.32,10,0.311,32,1.654,46,1.797,47,0.498,67,3.459,216,3.667,219,4.275]],["title/111",[47,0.37,83,2.487,114,2.929,215,3.712]],["description/111",[4,0.362,10,0.352,18,1.522,47,0.414,83,2.781,114,3.276,219,4.839]],["title/112",[47,0.41,81,2.406,82,2.672]],["description/112",[2,2.955,6,3.159,7,3.053,47,0.414,81,2.434,82,2.703,87,3.053]],["title/113",[8,0.89,19,1.659,47,0.338,81,1.987,82,2.207]],["description/113",[4,0.308,9,0.849,10,0.299,11,1.163,12,0.343,13,0.343,47,0.352,61,2.178,81,2.07,82,2.298,220,3.78]],["title/114",[16,1.694,19,1.659,47,0.338,81,1.987,82,2.207]],["description/114",[4,0.308,10,0.299,12,0.343,13,0.343,16,1.765,41,2.07,47,0.352,81,2.07,82,2.298,89,2.596,220,3.78]],["title/115",[18,1.361,19,1.817,47,0.37,81,2.177]],["description/115",[4,0.308,10,0.299,12,0.343,13,0.343,18,1.782,47,0.352,81,2.07,82,2.298,90,3.78,220,3.78]],["title/116",[8,0.974,47,0.37,81,2.177,82,2.417]],["description/116",[4,0.32,10,0.311,11,1.208,12,0.357,13,0.357,47,0.366,61,2.262,81,2.15,82,2.388,221,4.275]],["title/117",[30,1.927,47,0.41,81,2.406]],["description/117",[4,0.297,10,0.288,12,0.331,13,0.331,30,1.598,31,2.215,32,1.535,47,0.34,81,1.995,82,2.215,111,3.643,221,3.966]],["title/118",[0,0.289,1,0.333,8,0.705,24,0.95,46,0.968,47,0.268,51,1.913,81,1.576]],["description/118",[0,0.38,1,0.438,4,0.308,10,0.299,11,1.163,12,0.343,13,0.343,46,1.271,51,2.513,61,2.178,222,3.78]],["title/119",[0,0.289,1,0.496,46,0.968,47,0.268,51,1.913,81,1.576,82,1.75]],["description/119",[0,0.32,1,0.534,4,0.259,10,0.252,12,0.289,13,0.289,14,1.173,32,1.341,41,1.744,46,1.071,47,0.297,51,2.116,81,1.744,82,1.936,222,3.184]],["title/120",[0,0.311,1,0.358,46,1.039,47,0.288,50,2.278,51,2.054,81,1.692]],["description/120",[0,0.366,1,0.422,12,0.331,13,0.331,41,1.995,46,1.225,47,0.34,50,2.685,51,2.422,81,1.995,82,2.215,222,3.643]],["title/121",[204,3.373,223,5.347]],["description/121",[87,3.705,204,3.705,223,5.874]],["title/122",[224,6.81]],["description/122",[225,7.389]],["title/123",[0,0.442,1,0.509,136,1.889]],["description/123",[2,3.091,3,4.65,4,0.379,6,3.305,7,3.193,226,5.688]],["title/124",[0,0.365,1,0.42,8,0.89,9,0.815,136,1.56]],["description/124",[0,0.428,1,0.493,4,0.347,9,0.956,10,0.337,11,1.31,136,1.83,227,4.258]],["title/125",[0,0.4,1,0.46,16,1.856,136,1.708]],["description/125",[0,0.428,1,0.493,4,0.347,10,0.337,16,1.988,89,2.924,136,1.83,227,4.258]],["title/126",[0,0.365,1,0.42,9,0.815,18,1.243,136,1.56]],["description/126",[0,0.411,1,0.473,4,0.333,9,0.917,10,0.323,18,1.879,136,1.756,227,4.086]],["title/127",[0,0.311,1,0.358,8,0.758,19,1.413,46,1.039,83,1.934,136,1.328]],["description/127",[0,0.447,4,0.362,10,0.352,11,1.368,37,1.95,46,1.495,228,4.151]],["title/128",[229,6.81]],["description/128",[228,5.641]],["title/129",[0,0.336,1,0.387,19,1.526,46,1.123,83,2.088,136,1.435]],["description/129",[0,0.537,4,0.32,10,0.311,32,1.654,46,1.797,67,3.459,216,3.667,228,3.667]],["title/130",[0,0.311,1,0.358,19,1.413,63,2.886,83,1.934,114,2.278,136,1.328]],["description/130",[0,0.447,4,0.362,10,0.352,18,1.522,83,2.781,114,3.276,228,4.151]],["title/131",[0,0.4,1,0.46,8,0.974,136,1.708]],["description/131",[0,0.447,1,0.515,4,0.362,10,0.352,11,1.368,136,1.911,230,4.839]],["title/132",[0,0.365,1,0.42,30,1.592,31,2.207,136,1.56]],["description/132",[0,0.463,1,0.534,4,0.259,10,0.365,30,1.396,31,1.936,32,1.341,35,2.263,36,2.263,37,1.396,136,1.982,230,3.466]],["title/133",[0,0.336,1,0.387,19,1.526,46,1.123,83,2.088,136,1.435]],["description/133",[0,0.537,4,0.32,10,0.311,32,1.654,46,1.797,67,3.459,216,3.667,231,4.275]],["title/134",[0,0.311,1,0.358,19,1.413,83,1.934,114,2.278,136,1.328,232,3.78]],["description/134",[0,0.447,4,0.362,10,0.352,18,1.522,83,2.781,114,3.276,231,4.839]],["title/135",[0,0.442,1,0.509,112,1.096]],["description/135",[2,3.091,3,4.65,4,0.379,6,3.305,7,3.193,233,5.688]],["title/136",[0,0.365,1,0.42,8,0.89,9,0.815,112,0.905]],["description/136",[0,0.38,1,0.438,4,0.308,9,0.849,10,0.299,11,1.163,12,0.343,13,0.343,14,1.393,112,0.943,234,3.78]],["title/137",[0,0.4,1,0.46,16,1.856,112,0.992]],["description/137",[0,0.38,1,0.438,4,0.308,9,0.849,10,0.299,12,0.343,13,0.343,17,2.178,89,2.596,112,0.943,234,3.78]],["title/138",[0,0.365,1,0.42,18,1.243,19,1.659,112,0.905]],["description/138",[0,0.38,1,0.438,4,0.308,9,0.849,10,0.299,12,0.343,13,0.343,18,1.294,20,3.163,112,0.943,234,3.78]],["title/139",[0,0.4,1,0.46,8,0.974,112,0.992]],["description/139",[0,0.395,1,0.455,4,0.32,10,0.311,11,1.208,12,0.357,13,0.357,14,1.447,112,0.98,235,4.275]],["title/140",[0,0.365,1,0.42,30,1.592,31,2.207,112,0.905]],["description/140",[0,0.31,1,0.357,4,0.251,10,0.357,12,0.28,13,0.28,30,1.354,31,1.877,32,1.3,35,2.193,36,2.193,37,1.354,38,2.719,112,1.124,235,3.36]],["title/141",[0,0.289,1,0.333,8,0.705,70,0.968,71,0.934,112,1.068,236,2.205]],["description/141",[0,0.33,1,0.381,4,0.268,10,0.26,11,1.011,12,0.299,13,0.299,14,1.211,37,1.442,70,1.106,71,1.067,112,1.177,236,2.519,237,3.579]],["title/142",[0,0.289,1,0.333,70,0.968,71,0.934,112,1.068,236,2.205,238,3.132]],["description/142",[0,0.276,1,0.318,4,0.224,10,0.218,12,0.25,13,0.25,14,1.013,17,1.584,32,1.159,70,0.925,71,0.892,84,3.864,112,1.032,201,2.568,236,2.107,237,2.994,239,2.994,240,2.568,241,2.568]],["title/143",[0,0.289,1,0.333,8,0.705,70,0.968,71,0.934,112,1.068,242,2.3]],["description/143",[0,0.33,1,0.381,4,0.268,10,0.26,11,1.011,12,0.299,13,0.299,14,1.211,37,1.442,70,1.106,71,1.067,112,1.177,242,2.628,243,3.579]],["title/144",[0,0.289,1,0.333,70,0.968,71,0.934,112,1.068,238,3.132,242,2.3]],["description/144",[0,0.276,1,0.318,4,0.224,10,0.218,12,0.25,13,0.25,14,1.013,17,1.584,32,1.159,70,0.925,71,0.892,84,3.864,112,1.032,201,2.568,239,2.994,240,2.568,241,2.568,242,2.198,243,2.994]],["title/145",[0,0.271,1,0.312,8,0.66,9,0.604,70,0.905,71,0.873,112,1.016,236,2.062]],["description/145",[0,0.33,1,0.381,4,0.268,9,0.738,10,0.26,11,1.011,12,0.299,13,0.299,14,1.211,70,1.106,71,1.067,112,1.177,236,2.519,244,3.579]],["title/146",[0,0.336,1,0.387,18,1.143,71,1.083,112,0.833,236,2.558]],["description/146",[0,0.284,1,0.327,4,0.23,10,0.224,12,0.257,13,0.257,14,1.042,17,1.629,18,0.968,50,2.084,71,0.917,84,3.945,112,1.054,236,2.166,240,2.64,241,2.64,244,3.078,245,3.458]],["title/147",[0,0.271,1,0.312,8,0.66,9,0.604,70,0.905,71,0.873,112,1.016,242,2.151]],["description/147",[0,0.33,1,0.381,4,0.268,9,0.738,10,0.26,11,1.011,12,0.299,13,0.299,14,1.211,70,1.106,71,1.067,112,1.177,242,2.628,246,3.579]],["title/148",[0,0.336,1,0.387,18,1.143,71,1.083,112,0.833,242,2.668]],["description/148",[0,0.33,1,0.381,4,0.268,9,0.738,10,0.26,12,0.299,13,0.299,18,1.126,20,2.751,50,2.423,70,1.106,71,1.067,112,1.177,246,3.579]],["title/149",[186,4.911,187,3.073]],["description/149",[2,2.955,4,0.362,7,3.053,24,1.469,87,3.053,187,2.781,247,3.053]],["title/150",[8,0.89,23,1.987,24,1.199,187,2.27,247,2.492]],["description/150",[8,0.927,10,0.299,12,0.343,13,0.343,25,2.513,37,1.658,182,3.78,187,2.365,247,2.596,248,4.115,249,4.115]],["title/151",[16,1.856,187,2.487,247,2.729,250,4.862]],["description/151",[10,0.311,12,0.357,13,0.357,16,1.833,89,2.696,187,2.457,247,2.696,249,4.275,251,4.803,252,3.927]],["title/152",[8,0.89,23,1.987,24,1.199,187,2.27,247,2.492]],["description/152",[8,0.893,10,0.288,12,0.331,13,0.331,23,1.995,24,1.204,25,2.422,187,3.174,247,2.502,248,3.966,253,3.643]],["title/153",[16,1.694,23,1.987,24,1.199,187,2.27,247,2.492]],["description/153",[10,0.278,12,0.319,13,0.319,23,1.926,24,1.162,25,2.338,89,2.415,187,3.097,240,3.284,247,2.415,252,3.516,253,3.516]],["title/154",[18,1.243,23,1.987,24,1.199,187,2.27,247,2.492]],["description/154",[10,0.244,12,0.28,13,0.28,18,1.057,23,2.468,24,1.02,50,2.275,187,1.931,241,2.882,247,3.095,252,3.086,253,3.086,254,3.775,255,3.775,256,3.775]]],"invertedIndex":[["access",{"_index":152,"title":{},"description":{"50":{}}}],["action",{"_index":58,"title":{"16":{},"19":{},"30":{},"31":{},"32":{},"33":{},"48":{},"49":{},"50":{},"51":{},"52":{}},"description":{"11":{},"16":{},"19":{},"30":{},"31":{},"32":{},"33":{},"40":{},"41":{},"48":{},"49":{},"50":{},"51":{},"52":{}}}],["actionid",{"_index":154,"title":{},"description":{"52":{}}}],["activ",{"_index":96,"title":{"41":{}},"description":{"32":{},"40":{},"41":{}}}],["ad",{"_index":201,"title":{"84":{}},"description":{"84":{},"142":{},"144":{}}}],["add",{"_index":238,"title":{"142":{},"144":{}},"description":{}}],["afterward",{"_index":254,"title":{},"description":{"154":{}}}],["again",{"_index":45,"title":{},"description":{"11":{}}}],["alreadi",{"_index":216,"title":{},"description":{"106":{},"110":{},"129":{},"133":{}}}],["alway",{"_index":36,"title":{},"description":{"8":{},"13":{},"15":{},"35":{},"60":{},"82":{},"94":{},"109":{},"132":{},"140":{}}}],["anymor",{"_index":48,"title":{},"description":{"11":{}}}],["api",{"_index":87,"title":{},"description":{"23":{},"50":{},"53":{},"55":{},"61":{},"77":{},"86":{},"101":{},"112":{},"121":{},"149":{}}}],["approv",{"_index":183,"title":{"73":{}},"description":{"72":{},"73":{}}}],["approve_rollout",{"_index":189,"title":{},"description":{"72":{},"73":{}}}],["artifact",{"_index":204,"title":{"97":{},"98":{},"99":{},"100":{},"121":{}},"description":{"86":{},"97":{},"98":{},"99":{},"100":{},"121":{}}}],["assign",{"_index":46,"title":{"12":{},"13":{},"14":{},"15":{},"16":{},"18":{},"21":{},"22":{},"36":{},"42":{},"43":{},"97":{},"105":{},"106":{},"110":{},"118":{},"119":{},"120":{},"127":{},"129":{},"133":{}},"description":{"11":{},"12":{},"13":{},"15":{},"16":{},"18":{},"21":{},"22":{},"36":{},"42":{},"43":{},"97":{},"100":{},"105":{},"106":{},"110":{},"118":{},"119":{},"120":{},"127":{},"129":{},"133":{}}}],["assigndistributionsetsput",{"_index":229,"title":{"128":{}},"description":{}}],["attribut",{"_index":142,"title":{"47":{}},"description":{"47":{}}}],["auth",{"_index":158,"title":{},"description":{"53":{}}}],["authent",{"_index":157,"title":{"53":{}},"description":{}}],["auto",{"_index":51,"title":{"16":{},"18":{},"21":{},"118":{},"119":{},"120":{}},"description":{"11":{},"16":{},"18":{},"118":{},"119":{},"120":{}}}],["auto-confirm",{"_index":118,"title":{"40":{},"41":{}},"description":{"40":{},"41":{},"46":{}}}],["auto-confitm",{"_index":139,"title":{"46":{}},"description":{}}],["automat",{"_index":128,"title":{},"description":{"41":{}}}],["basic",{"_index":156,"title":{"53":{}},"description":{"53":{}}}],["batch",{"_index":250,"title":{"151":{}},"description":{}}],["befor",{"_index":122,"title":{},"description":{"40":{}}}],["bodi",{"_index":35,"title":{},"description":{"8":{},"13":{},"15":{},"35":{},"60":{},"82":{},"94":{},"109":{},"132":{},"140":{}}}],["cancel",{"_index":55,"title":{"32":{}},"description":{"11":{},"32":{}}}],["case",{"_index":105,"title":{},"description":{"33":{}}}],["chang",{"_index":240,"title":{},"description":{"142":{},"144":{},"146":{},"153":{}}}],["check",{"_index":140,"title":{},"description":{"46":{}}}],["choos",{"_index":54,"title":{},"description":{"11":{}}}],["compat",{"_index":199,"title":{"83":{},"84":{},"85":{}},"description":{"83":{},"84":{}}}],["configur",{"_index":187,"title":{"149":{},"150":{},"151":{},"152":{},"153":{},"154":{}},"description":{"72":{},"73":{},"149":{},"150":{},"151":{},"152":{},"153":{},"154":{}}}],["confirm",{"_index":100,"title":{"33":{}},"description":{"33":{},"40":{},"41":{}}}],["confirm/deni",{"_index":98,"title":{"33":{}},"description":{}}],["connect",{"_index":59,"title":{},"description":{"11":{}}}],["control",{"_index":97,"title":{"33":{}},"description":{}}],["count",{"_index":73,"title":{"16":{},"17":{},"18":{},"19":{}},"description":{"16":{},"17":{},"18":{},"19":{}}}],["creat",{"_index":30,"title":{"8":{},"10":{},"35":{},"39":{},"60":{},"66":{},"82":{},"94":{},"96":{},"109":{},"117":{},"132":{},"140":{}},"description":{"8":{},"10":{},"35":{},"39":{},"60":{},"66":{},"68":{},"72":{},"73":{},"82":{},"94":{},"96":{},"109":{},"117":{},"132":{},"140":{}}}],["create_repositori",{"_index":38,"title":{},"description":{"8":{},"60":{},"94":{},"98":{},"140":{}}}],["create_rollout",{"_index":169,"title":{},"description":{"66":{},"69":{}}}],["create_target",{"_index":111,"title":{},"description":{"35":{},"82":{},"117":{}}}],["crud",{"_index":6,"title":{},"description":{"0":{},"23":{},"55":{},"61":{},"77":{},"86":{},"101":{},"112":{},"123":{},"135":{}}}],["current",{"_index":126,"title":{"46":{}},"description":{"41":{},"46":{}}}],["data",{"_index":22,"title":{"4":{},"5":{},"6":{},"9":{},"10":{}},"description":{"4":{},"5":{},"6":{},"9":{},"10":{}}}],["deactiv",{"_index":117,"title":{"40":{}},"description":{"40":{}}}],["default",{"_index":256,"title":{},"description":{"154":{}}}],["delet",{"_index":18,"title":{"3":{},"6":{},"22":{},"26":{},"29":{},"58":{},"64":{},"80":{},"89":{},"92":{},"100":{},"104":{},"115":{},"126":{},"138":{},"146":{},"148":{},"154":{}},"description":{"3":{},"6":{},"22":{},"26":{},"29":{},"32":{},"58":{},"64":{},"80":{},"85":{},"89":{},"92":{},"100":{},"104":{},"107":{},"111":{},"115":{},"126":{},"130":{},"134":{},"138":{},"146":{},"148":{},"154":{}}}],["delete_repositori",{"_index":20,"title":{},"description":{"3":{},"58":{},"89":{},"100":{},"138":{},"148":{}}}],["delete_rollout",{"_index":167,"title":{},"description":{"64":{}}}],["delete_target",{"_index":90,"title":{},"description":{"26":{},"80":{},"115":{}}}],["deni",{"_index":101,"title":{"72":{}},"description":{"33":{},"72":{}}}],["deploy",{"_index":124,"title":{},"description":{"40":{},"74":{},"75":{},"76":{}}}],["distribut",{"_index":0,"title":{"0":{},"1":{},"2":{},"3":{},"4":{},"5":{},"6":{},"7":{},"8":{},"9":{},"10":{},"11":{},"12":{},"13":{},"14":{},"15":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{},"22":{},"42":{},"43":{},"45":{},"83":{},"84":{},"85":{},"118":{},"119":{},"120":{},"123":{},"124":{},"125":{},"126":{},"127":{},"129":{},"130":{},"131":{},"132":{},"133":{},"134":{},"135":{},"136":{},"137":{},"138":{},"139":{},"140":{},"141":{},"142":{},"143":{},"144":{},"145":{},"146":{},"147":{},"148":{}},"description":{"1":{},"2":{},"3":{},"7":{},"8":{},"9":{},"11":{},"12":{},"13":{},"14":{},"15":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{},"42":{},"43":{},"45":{},"83":{},"84":{},"85":{},"118":{},"119":{},"120":{},"124":{},"125":{},"126":{},"127":{},"129":{},"130":{},"131":{},"132":{},"133":{},"134":{},"136":{},"137":{},"138":{},"139":{},"140":{},"141":{},"142":{},"143":{},"144":{},"145":{},"146":{},"147":{},"148":{}}}],["distributionset",{"_index":5,"title":{},"description":{"0":{}}}],["distributionsettag",{"_index":226,"title":{},"description":{"123":{}}}],["distributionsettyp",{"_index":233,"title":{},"description":{"135":{}}}],["download",{"_index":223,"title":{"121":{}},"description":{"121":{}}}],["downloadartifact_1",{"_index":224,"title":{"122":{}},"description":{}}],["ds",{"_index":84,"title":{"21":{}},"description":{"142":{},"144":{},"146":{}}}],["enabl",{"_index":185,"title":{},"description":{"72":{},"73":{}}}],["entri",{"_index":28,"title":{"6":{},"29":{},"92":{}},"description":{"10":{},"39":{},"96":{}}}],["filter",{"_index":81,"title":{"21":{},"112":{},"113":{},"114":{},"115":{},"116":{},"117":{},"118":{},"119":{},"120":{}},"description":{"21":{},"112":{},"113":{},"114":{},"115":{},"116":{},"117":{},"119":{},"120":{}}}],["forc",{"_index":57,"title":{"31":{},"67":{}},"description":{"11":{},"31":{}}}],["full",{"_index":146,"title":{},"description":{"48":{}}}],["furthermor",{"_index":52,"title":{},"description":{"11":{}}}],["futur",{"_index":120,"title":{},"description":{"40":{},"41":{}}}],["given",{"_index":83,"title":{"21":{},"106":{},"107":{},"110":{},"111":{},"127":{},"129":{},"130":{},"133":{},"134":{}},"description":{"107":{},"111":{},"130":{},"134":{}}}],["global",{"_index":255,"title":{},"description":{"154":{}}}],["go",{"_index":49,"title":{},"description":{"11":{}}}],["group",{"_index":171,"title":{"67":{},"74":{},"75":{},"76":{}},"description":{"67":{},"74":{},"75":{},"76":{}}}],["handl",{"_index":4,"title":{},"description":{"0":{},"1":{},"2":{},"3":{},"7":{},"8":{},"12":{},"13":{},"14":{},"15":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{},"24":{},"25":{},"26":{},"30":{},"31":{},"34":{},"35":{},"40":{},"41":{},"42":{},"43":{},"45":{},"46":{},"47":{},"48":{},"49":{},"51":{},"52":{},"56":{},"57":{},"58":{},"59":{},"60":{},"62":{},"63":{},"64":{},"65":{},"66":{},"67":{},"68":{},"69":{},"70":{},"71":{},"72":{},"73":{},"74":{},"75":{},"76":{},"78":{},"79":{},"80":{},"81":{},"82":{},"83":{},"84":{},"85":{},"87":{},"88":{},"89":{},"93":{},"94":{},"97":{},"98":{},"99":{},"100":{},"102":{},"103":{},"104":{},"105":{},"106":{},"107":{},"108":{},"109":{},"110":{},"111":{},"113":{},"114":{},"115":{},"116":{},"117":{},"118":{},"119":{},"123":{},"124":{},"125":{},"126":{},"127":{},"129":{},"130":{},"131":{},"132":{},"133":{},"134":{},"135":{},"136":{},"137":{},"138":{},"139":{},"140":{},"141":{},"142":{},"143":{},"144":{},"145":{},"146":{},"147":{},"148":{},"149":{}}}],["handle_rollout",{"_index":174,"title":{},"description":{"68":{},"70":{},"71":{}}}],["hawkbit",{"_index":34,"title":{},"description":{"8":{},"88":{},"89":{}}}],["histori",{"_index":147,"title":{},"description":{"48":{}}}],["id",{"_index":19,"title":{"3":{},"24":{},"25":{},"26":{},"30":{},"52":{},"58":{},"78":{},"79":{},"80":{},"87":{},"89":{},"100":{},"102":{},"103":{},"104":{},"113":{},"114":{},"115":{},"127":{},"129":{},"130":{},"133":{},"134":{},"138":{}},"description":{"13":{},"15":{}}}],["ignor",{"_index":67,"title":{},"description":{"13":{},"106":{},"110":{},"129":{},"133":{}}}],["initi",{"_index":130,"title":{},"description":{"41":{}}}],["instal",{"_index":79,"title":{"20":{},"45":{}},"description":{"20":{},"45":{}}}],["invalid",{"_index":42,"title":{"11":{}},"description":{"11":{}}}],["key",{"_index":25,"title":{"4":{},"27":{},"90":{}},"description":{"4":{},"5":{},"27":{},"28":{},"90":{},"91":{},"150":{},"152":{},"153":{}}}],["key/valu",{"_index":144,"title":{},"description":{"47":{}}}],["list",{"_index":37,"title":{"10":{},"15":{},"39":{},"83":{},"96":{}},"description":{"8":{},"9":{},"10":{},"13":{},"15":{},"35":{},"38":{},"39":{},"44":{},"47":{},"60":{},"82":{},"83":{},"94":{},"95":{},"96":{},"105":{},"109":{},"127":{},"132":{},"140":{},"141":{},"143":{},"150":{}}}],["long",{"_index":133,"title":{},"description":{"41":{}}}],["mandatori",{"_index":242,"title":{"143":{},"144":{},"147":{},"148":{}},"description":{"143":{},"144":{},"147":{}}}],["mention",{"_index":129,"title":{},"description":{"41":{}}}],["meta",{"_index":21,"title":{"4":{},"5":{},"6":{},"9":{},"10":{}},"description":{"4":{},"5":{},"6":{},"9":{},"10":{}}}],["metadata",{"_index":91,"title":{"27":{},"28":{},"29":{},"38":{},"39":{},"90":{},"91":{},"92":{},"95":{},"96":{},"97":{},"99":{}},"description":{"27":{},"28":{},"29":{},"38":{},"39":{},"90":{},"91":{},"92":{},"95":{},"96":{},"97":{},"99":{}}}],["modul",{"_index":71,"title":{"14":{},"15":{},"22":{},"55":{},"56":{},"57":{},"58":{},"59":{},"60":{},"86":{},"87":{},"88":{},"89":{},"90":{},"91":{},"92":{},"93":{},"95":{},"96":{},"97":{},"141":{},"142":{},"143":{},"144":{},"145":{},"146":{},"147":{},"148":{}},"description":{"15":{},"56":{},"57":{},"58":{},"59":{},"60":{},"94":{},"95":{},"97":{},"141":{},"142":{},"143":{},"144":{},"145":{},"146":{},"147":{},"148":{}}}],["module(",{"_index":208,"title":{"94":{}},"description":{}}],["multipl",{"_index":63,"title":{"13":{},"130":{}},"description":{"13":{},"15":{}}}],["need",{"_index":121,"title":{},"description":{"40":{}}}],["new",{"_index":31,"title":{"8":{},"60":{},"66":{},"132":{},"140":{}},"description":{"8":{},"35":{},"60":{},"66":{},"82":{},"94":{},"109":{},"117":{},"132":{},"140":{}}}],["next",{"_index":170,"title":{"67":{}},"description":{"67":{}}}],["non-exist",{"_index":65,"title":{},"description":{"13":{}}}],["note",{"_index":245,"title":{},"description":{"146":{}}}],["null",{"_index":115,"title":{},"description":{"37":{}}}],["on",{"_index":232,"title":{"134":{}},"description":{}}],["onc",{"_index":43,"title":{},"description":{"11":{}}}],["oper",{"_index":7,"title":{},"description":{"0":{},"23":{},"55":{},"61":{},"77":{},"86":{},"101":{},"112":{},"123":{},"135":{},"149":{}}}],["option",{"_index":236,"title":{"141":{},"142":{},"145":{},"146":{}},"description":{"141":{},"142":{},"145":{},"146":{}}}],["page",{"_index":39,"title":{},"description":{"9":{},"38":{},"44":{},"95":{}}}],["paus",{"_index":179,"title":{"71":{}},"description":{"70":{},"71":{}}}],["permiss",{"_index":13,"title":{},"description":{"1":{},"2":{},"3":{},"4":{},"5":{},"6":{},"7":{},"8":{},"9":{},"10":{},"11":{},"12":{},"13":{},"14":{},"15":{},"20":{},"21":{},"22":{},"24":{},"25":{},"26":{},"27":{},"28":{},"29":{},"30":{},"31":{},"32":{},"33":{},"34":{},"35":{},"36":{},"37":{},"38":{},"39":{},"40":{},"41":{},"42":{},"43":{},"44":{},"45":{},"46":{},"47":{},"48":{},"49":{},"56":{},"57":{},"58":{},"59":{},"60":{},"62":{},"63":{},"64":{},"65":{},"66":{},"67":{},"68":{},"69":{},"70":{},"71":{},"72":{},"73":{},"74":{},"75":{},"76":{},"79":{},"80":{},"82":{},"83":{},"84":{},"85":{},"87":{},"88":{},"89":{},"90":{},"91":{},"92":{},"93":{},"94":{},"95":{},"96":{},"97":{},"98":{},"99":{},"100":{},"113":{},"114":{},"115":{},"116":{},"117":{},"118":{},"119":{},"120":{},"136":{},"137":{},"138":{},"139":{},"140":{},"141":{},"142":{},"143":{},"144":{},"145":{},"146":{},"147":{},"148":{},"150":{},"151":{},"152":{},"153":{},"154":{}}}],["person",{"_index":132,"title":{},"description":{"41":{}}}],["possibl",{"_index":182,"title":{},"description":{"72":{},"73":{},"150":{}}}],["post",{"_index":32,"title":{},"description":{"8":{},"13":{},"15":{},"35":{},"40":{},"41":{},"43":{},"60":{},"66":{},"67":{},"68":{},"69":{},"70":{},"71":{},"72":{},"73":{},"82":{},"84":{},"94":{},"98":{},"106":{},"109":{},"110":{},"117":{},"119":{},"129":{},"132":{},"133":{},"140":{},"142":{},"144":{}}}],["process",{"_index":123,"title":{"67":{}},"description":{"40":{}}}],["provid",{"_index":150,"title":{},"description":{"50":{}}}],["put",{"_index":89,"title":{},"description":{"25":{},"31":{},"57":{},"79":{},"88":{},"103":{},"114":{},"125":{},"137":{},"151":{},"153":{}}}],["queri",{"_index":82,"title":{"21":{},"112":{},"113":{},"114":{},"116":{},"119":{}},"description":{"21":{},"112":{},"113":{},"114":{},"115":{},"116":{},"117":{},"119":{},"120":{}}}],["read-onli",{"_index":151,"title":{},"description":{"50":{}}}],["read_repositori",{"_index":14,"title":{},"description":{"1":{},"4":{},"7":{},"9":{},"10":{},"12":{},"13":{},"14":{},"15":{},"20":{},"21":{},"27":{},"33":{},"38":{},"39":{},"43":{},"44":{},"56":{},"59":{},"83":{},"84":{},"85":{},"87":{},"90":{},"93":{},"95":{},"97":{},"99":{},"119":{},"136":{},"139":{},"141":{},"142":{},"143":{},"144":{},"145":{},"146":{},"147":{}}}],["read_rollout",{"_index":164,"title":{},"description":{"62":{},"65":{},"74":{},"75":{},"76":{}}}],["read_target",{"_index":61,"title":{},"description":{"12":{},"20":{},"21":{},"24":{},"30":{},"34":{},"42":{},"45":{},"46":{},"47":{},"48":{},"49":{},"76":{},"83":{},"113":{},"116":{},"118":{}}}],["read_tenant_configur",{"_index":248,"title":{},"description":{"150":{},"152":{}}}],["refer",{"_index":192,"title":{"74":{}},"description":{}}],["relat",{"_index":195,"title":{"76":{}},"description":{"86":{}}}],["remain",{"_index":106,"title":{},"description":{"33":{},"40":{}}}],["remov",{"_index":50,"title":{"85":{},"120":{}},"description":{"11":{},"37":{},"85":{},"120":{},"146":{},"148":{},"154":{}}}],["repons",{"_index":143,"title":{},"description":{"47":{}}}],["request",{"_index":10,"title":{},"description":{"1":{},"2":{},"3":{},"7":{},"8":{},"12":{},"13":{},"14":{},"15":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{},"24":{},"25":{},"26":{},"30":{},"31":{},"34":{},"35":{},"40":{},"41":{},"42":{},"43":{},"45":{},"46":{},"47":{},"48":{},"49":{},"51":{},"52":{},"56":{},"57":{},"58":{},"59":{},"60":{},"62":{},"63":{},"64":{},"65":{},"66":{},"67":{},"68":{},"69":{},"70":{},"71":{},"72":{},"73":{},"74":{},"75":{},"76":{},"78":{},"79":{},"80":{},"81":{},"82":{},"83":{},"84":{},"85":{},"87":{},"88":{},"89":{},"93":{},"94":{},"97":{},"98":{},"99":{},"100":{},"102":{},"103":{},"104":{},"105":{},"106":{},"107":{},"108":{},"109":{},"110":{},"111":{},"113":{},"114":{},"115":{},"116":{},"117":{},"118":{},"119":{},"124":{},"125":{},"126":{},"127":{},"129":{},"130":{},"131":{},"132":{},"133":{},"134":{},"136":{},"137":{},"138":{},"139":{},"140":{},"141":{},"142":{},"143":{},"144":{},"145":{},"146":{},"147":{},"148":{},"150":{},"151":{},"152":{},"153":{},"154":{}}}],["requir",{"_index":12,"title":{},"description":{"1":{},"2":{},"3":{},"4":{},"5":{},"6":{},"7":{},"8":{},"9":{},"10":{},"11":{},"12":{},"13":{},"14":{},"15":{},"20":{},"21":{},"22":{},"24":{},"25":{},"26":{},"27":{},"28":{},"29":{},"30":{},"31":{},"32":{},"33":{},"34":{},"35":{},"36":{},"37":{},"38":{},"39":{},"40":{},"41":{},"42":{},"43":{},"44":{},"45":{},"46":{},"47":{},"48":{},"49":{},"56":{},"57":{},"58":{},"59":{},"60":{},"62":{},"63":{},"64":{},"65":{},"66":{},"67":{},"68":{},"69":{},"70":{},"71":{},"72":{},"73":{},"74":{},"75":{},"76":{},"79":{},"80":{},"82":{},"83":{},"84":{},"85":{},"87":{},"88":{},"89":{},"90":{},"91":{},"92":{},"93":{},"94":{},"95":{},"96":{},"97":{},"98":{},"99":{},"100":{},"113":{},"114":{},"115":{},"116":{},"117":{},"118":{},"119":{},"120":{},"136":{},"137":{},"138":{},"139":{},"140":{},"141":{},"142":{},"143":{},"144":{},"145":{},"146":{},"147":{},"148":{},"150":{},"151":{},"152":{},"153":{},"154":{}}}],["resourc",{"_index":3,"title":{},"description":{"0":{},"123":{},"135":{}}}],["respons",{"_index":69,"title":{},"description":{"13":{}}}],["rest",{"_index":2,"title":{},"description":{"0":{},"23":{},"50":{},"55":{},"61":{},"77":{},"86":{},"101":{},"112":{},"123":{},"135":{},"149":{}}}],["rest/v1/act",{"_index":153,"title":{},"description":{"51":{}}}],["rest/v1/actions/{actionid",{"_index":155,"title":{},"description":{"52":{}}}],["rest/v1/distributionset",{"_index":29,"title":{},"description":{"7":{},"8":{}}}],["rest/v1/distributionsets/{distributionsetid",{"_index":15,"title":{},"description":{"1":{},"2":{},"3":{}}}],["rest/v1/distributionsets/{distributionsetid}/assignedsm",{"_index":72,"title":{},"description":{"14":{},"15":{}}}],["rest/v1/distributionsets/{distributionsetid}/assignedsm/{softwaremoduleid",{"_index":86,"title":{},"description":{"22":{}}}],["rest/v1/distributionsets/{distributionsetid}/assignedtarget",{"_index":62,"title":{},"description":{"12":{},"13":{}}}],["rest/v1/distributionsets/{distributionsetid}/autoassigntargetfilt",{"_index":85,"title":{},"description":{"21":{}}}],["rest/v1/distributionsets/{distributionsetid}/installedtarget",{"_index":80,"title":{},"description":{"20":{}}}],["rest/v1/distributionsets/{distributionsetid}/invalid",{"_index":60,"title":{},"description":{"11":{}}}],["rest/v1/distributionsets/{distributionsetid}/metadata",{"_index":40,"title":{},"description":{"9":{},"10":{}}}],["rest/v1/distributionsets/{distributionsetid}/metadata/{metadatakey",{"_index":26,"title":{},"description":{"4":{},"5":{},"6":{}}}],["rest/v1/distributionsets/{distributionsetid}/statist",{"_index":75,"title":{},"description":{"16":{}}}],["rest/v1/distributionsets/{distributionsetid}/statistics/act",{"_index":78,"title":{},"description":{"19":{}}}],["rest/v1/distributionsets/{distributionsetid}/statistics/autoassign",{"_index":77,"title":{},"description":{"18":{}}}],["rest/v1/distributionsets/{distributionsetid}/statistics/rollout",{"_index":76,"title":{},"description":{"17":{}}}],["rest/v1/distributionsettag",{"_index":230,"title":{},"description":{"131":{},"132":{}}}],["rest/v1/distributionsettags/{distributionsettagid",{"_index":227,"title":{},"description":{"124":{},"125":{},"126":{}}}],["rest/v1/distributionsettags/{distributionsettagid}/assign",{"_index":228,"title":{},"description":{"127":{},"128":{},"129":{},"130":{}}}],["rest/v1/distributionsettags/{distributionsettagid}/assigned/{distributionsetid",{"_index":231,"title":{},"description":{"133":{},"134":{}}}],["rest/v1/distributionsettyp",{"_index":235,"title":{},"description":{"139":{},"140":{}}}],["rest/v1/distributionsettypes/{distributionsettypeid",{"_index":234,"title":{},"description":{"136":{},"137":{},"138":{}}}],["rest/v1/distributionsettypes/{distributionsettypeid}/mandatorymoduletyp",{"_index":243,"title":{},"description":{"143":{},"144":{}}}],["rest/v1/distributionsettypes/{distributionsettypeid}/mandatorymoduletypes/{softwaremoduletypeid",{"_index":246,"title":{},"description":{"147":{},"148":{}}}],["rest/v1/distributionsettypes/{distributionsettypeid}/optionalmoduletyp",{"_index":237,"title":{},"description":{"141":{},"142":{}}}],["rest/v1/distributionsettypes/{distributionsettypeid}/optionalmoduletypes/{softwaremoduletypeid",{"_index":244,"title":{},"description":{"145":{},"146":{}}}],["rest/v1/rollout",{"_index":168,"title":{},"description":{"65":{},"66":{}}}],["rest/v1/rollouts/{rolloutid",{"_index":165,"title":{},"description":{"62":{},"63":{},"64":{}}}],["rest/v1/rollouts/{rolloutid}/approv",{"_index":191,"title":{},"description":{"73":{}}}],["rest/v1/rollouts/{rolloutid}/deni",{"_index":190,"title":{},"description":{"72":{}}}],["rest/v1/rollouts/{rolloutid}/deploygroup",{"_index":193,"title":{},"description":{"74":{}}}],["rest/v1/rollouts/{rolloutid}/deploygroups/{groupid",{"_index":194,"title":{},"description":{"75":{}}}],["rest/v1/rollouts/{rolloutid}/deploygroups/{groupid}/target",{"_index":196,"title":{},"description":{"76":{}}}],["rest/v1/rollouts/{rolloutid}/paus",{"_index":181,"title":{},"description":{"71":{}}}],["rest/v1/rollouts/{rolloutid}/resum",{"_index":180,"title":{},"description":{"70":{}}}],["rest/v1/rollouts/{rolloutid}/retri",{"_index":177,"title":{},"description":{"69":{}}}],["rest/v1/rollouts/{rolloutid}/start",{"_index":175,"title":{},"description":{"68":{}}}],["rest/v1/rollouts/{rolloutid}/triggernextgroup",{"_index":172,"title":{},"description":{"67":{}}}],["rest/v1/softwaremodul",{"_index":207,"title":{},"description":{"93":{},"94":{}}}],["rest/v1/softwaremodules/{softwaremoduleid",{"_index":205,"title":{},"description":{"87":{},"88":{},"89":{}}}],["rest/v1/softwaremodules/{softwaremoduleid}/artifact",{"_index":210,"title":{},"description":{"97":{},"98":{}}}],["rest/v1/softwaremodules/{softwaremoduleid}/artifacts/{artifactid",{"_index":212,"title":{},"description":{"99":{},"100":{}}}],["rest/v1/softwaremodules/{softwaremoduleid}/artifacts/{artifactid}/download",{"_index":225,"title":{},"description":{"122":{}}}],["rest/v1/softwaremodules/{softwaremoduleid}/metadata",{"_index":209,"title":{},"description":{"95":{},"96":{}}}],["rest/v1/softwaremodules/{softwaremoduleid}/metadata/{metadatakey",{"_index":206,"title":{},"description":{"90":{},"91":{},"92":{}}}],["rest/v1/softwaremoduletyp",{"_index":163,"title":{},"description":{"59":{},"60":{}}}],["rest/v1/softwaremoduletypes/{softwaremoduletypeid",{"_index":162,"title":{},"description":{"56":{},"57":{},"58":{}}}],["rest/v1/system/config",{"_index":249,"title":{},"description":{"150":{},"151":{}}}],["rest/v1/system/configs/{keynam",{"_index":253,"title":{},"description":{"152":{},"153":{},"154":{}}}],["rest/v1/target",{"_index":109,"title":{},"description":{"34":{},"35":{}}}],["rest/v1/targetfilt",{"_index":221,"title":{},"description":{"116":{},"117":{}}}],["rest/v1/targetfilters/{filterid",{"_index":220,"title":{},"description":{"113":{},"114":{},"115":{}}}],["rest/v1/targetfilters/{filterid}/autoassignd",{"_index":222,"title":{},"description":{"118":{},"119":{},"120":{}}}],["rest/v1/targets/{targetid",{"_index":88,"title":{},"description":{"24":{},"25":{},"26":{}}}],["rest/v1/targets/{targetid}/act",{"_index":148,"title":{},"description":{"48":{}}}],["rest/v1/targets/{targetid}/actions/{actionid",{"_index":93,"title":{},"description":{"30":{},"31":{},"32":{}}}],["rest/v1/targets/{targetid}/actions/{actionid}/confirm",{"_index":108,"title":{},"description":{"33":{}}}],["rest/v1/targets/{targetid}/actions/{actionid}/statu",{"_index":149,"title":{},"description":{"49":{}}}],["rest/v1/targets/{targetid}/assignedd",{"_index":135,"title":{},"description":{"42":{},"43":{}}}],["rest/v1/targets/{targetid}/attribut",{"_index":145,"title":{},"description":{"47":{}}}],["rest/v1/targets/{targetid}/autoconfirm",{"_index":141,"title":{},"description":{"46":{}}}],["rest/v1/targets/{targetid}/autoconfirm/activ",{"_index":134,"title":{},"description":{"41":{}}}],["rest/v1/targets/{targetid}/autoconfirm/deactiv",{"_index":125,"title":{},"description":{"40":{}}}],["rest/v1/targets/{targetid}/installedd",{"_index":138,"title":{},"description":{"45":{}}}],["rest/v1/targets/{targetid}/metadata",{"_index":116,"title":{},"description":{"38":{},"39":{}}}],["rest/v1/targets/{targetid}/metadata/{metadatakey",{"_index":92,"title":{},"description":{"27":{},"28":{},"29":{}}}],["rest/v1/targets/{targetid}/tag",{"_index":137,"title":{},"description":{"44":{}}}],["rest/v1/targets/{targetid}/targettyp",{"_index":113,"title":{},"description":{"36":{},"37":{}}}],["rest/v1/targettag",{"_index":217,"title":{},"description":{"108":{},"109":{}}}],["rest/v1/targettags/{targettagid",{"_index":213,"title":{},"description":{"102":{},"103":{},"104":{}}}],["rest/v1/targettags/{targettagid}/assign",{"_index":214,"title":{},"description":{"105":{},"106":{},"107":{}}}],["rest/v1/targettags/{targettagid}/assigned/{controllerid",{"_index":219,"title":{},"description":{"110":{},"111":{}}}],["rest/v1/targettyp",{"_index":198,"title":{},"description":{"81":{},"82":{}}}],["rest/v1/targettypes/{targettypeid",{"_index":197,"title":{},"description":{"78":{},"79":{},"80":{}}}],["rest/v1/targettypes/{targettypeid}/compatibledistributionsettyp",{"_index":200,"title":{},"description":{"83":{},"84":{}}}],["rest/v1/targettypes/{targettypeid}/compatibledistributionsettypes/{distributionsettypeid",{"_index":202,"title":{},"description":{"85":{}}}],["rest/v1/userinfo",{"_index":160,"title":{},"description":{"54":{}}}],["result",{"_index":68,"title":{},"description":{"13":{},"41":{}}}],["resum",{"_index":178,"title":{"70":{}},"description":{"70":{}}}],["retri",{"_index":176,"title":{"69":{}},"description":{"69":{}}}],["retriev",{"_index":11,"title":{},"description":{"1":{},"7":{},"12":{},"14":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{},"24":{},"30":{},"34":{},"42":{},"45":{},"47":{},"48":{},"49":{},"51":{},"52":{},"56":{},"59":{},"62":{},"65":{},"74":{},"76":{},"78":{},"81":{},"83":{},"87":{},"93":{},"97":{},"99":{},"102":{},"105":{},"108":{},"113":{},"116":{},"118":{},"124":{},"127":{},"131":{},"136":{},"139":{},"141":{},"143":{},"145":{},"147":{}}}],["return",{"_index":8,"title":{"1":{},"4":{},"7":{},"9":{},"12":{},"14":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{},"24":{},"27":{},"30":{},"34":{},"38":{},"42":{},"44":{},"45":{},"46":{},"47":{},"48":{},"49":{},"51":{},"52":{},"56":{},"59":{},"62":{},"65":{},"74":{},"75":{},"76":{},"78":{},"81":{},"83":{},"87":{},"90":{},"93":{},"95":{},"97":{},"99":{},"102":{},"105":{},"108":{},"113":{},"116":{},"118":{},"124":{},"127":{},"131":{},"136":{},"139":{},"141":{},"143":{},"145":{},"147":{},"150":{},"152":{}},"description":{"150":{},"152":{}}}],["rollout",{"_index":56,"title":{"16":{},"17":{},"61":{},"62":{},"63":{},"64":{},"65":{},"66":{},"67":{},"68":{},"69":{},"70":{},"71":{},"72":{},"73":{},"74":{},"75":{},"76":{}},"description":{"11":{},"16":{},"17":{},"61":{},"62":{},"63":{},"64":{},"65":{},"66":{},"67":{},"68":{},"69":{},"70":{},"71":{},"72":{},"73":{},"74":{},"75":{},"76":{}}}],["run",{"_index":103,"title":{},"description":{"33":{},"71":{}}}],["set",{"_index":1,"title":{"0":{},"1":{},"2":{},"3":{},"4":{},"5":{},"6":{},"7":{},"8":{},"9":{},"10":{},"11":{},"12":{},"13":{},"14":{},"15":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{},"22":{},"42":{},"43":{},"45":{},"83":{},"84":{},"85":{},"118":{},"119":{},"120":{},"123":{},"124":{},"125":{},"126":{},"127":{},"129":{},"130":{},"131":{},"132":{},"133":{},"134":{},"135":{},"136":{},"137":{},"138":{},"139":{},"140":{},"141":{},"142":{},"143":{},"144":{},"145":{},"146":{},"147":{},"148":{}},"description":{"1":{},"2":{},"3":{},"7":{},"8":{},"9":{},"11":{},"12":{},"14":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{},"37":{},"42":{},"43":{},"45":{},"83":{},"84":{},"85":{},"118":{},"119":{},"120":{},"124":{},"125":{},"126":{},"131":{},"132":{},"136":{},"137":{},"138":{},"139":{},"140":{},"141":{},"142":{},"143":{},"144":{},"145":{},"146":{},"147":{},"148":{}}}],["set.th",{"_index":64,"title":{},"description":{"13":{},"15":{}}}],["silent",{"_index":66,"title":{},"description":{"13":{}}}],["singl",{"_index":9,"title":{"1":{},"4":{},"5":{},"6":{},"13":{},"27":{},"28":{},"29":{},"56":{},"62":{},"75":{},"90":{},"91":{},"92":{},"99":{},"124":{},"126":{},"136":{},"145":{},"147":{}},"description":{"1":{},"2":{},"3":{},"4":{},"5":{},"6":{},"12":{},"14":{},"20":{},"21":{},"24":{},"26":{},"27":{},"28":{},"29":{},"52":{},"56":{},"57":{},"58":{},"62":{},"63":{},"75":{},"76":{},"78":{},"79":{},"80":{},"85":{},"87":{},"88":{},"89":{},"90":{},"91":{},"92":{},"99":{},"100":{},"102":{},"104":{},"113":{},"124":{},"126":{},"136":{},"137":{},"138":{},"145":{},"147":{},"148":{}}}],["soft",{"_index":95,"title":{"31":{}},"description":{"31":{}}}],["softwar",{"_index":70,"title":{"14":{},"15":{},"22":{},"55":{},"56":{},"57":{},"58":{},"59":{},"60":{},"86":{},"87":{},"88":{},"89":{},"90":{},"91":{},"92":{},"93":{},"94":{},"95":{},"96":{},"97":{},"141":{},"142":{},"143":{},"144":{},"145":{},"147":{}},"description":{"15":{},"56":{},"57":{},"58":{},"59":{},"60":{},"94":{},"95":{},"97":{},"141":{},"142":{},"143":{},"144":{},"145":{},"147":{},"148":{}}}],["softwaremodul",{"_index":203,"title":{},"description":{"86":{},"87":{},"88":{},"89":{},"93":{},"100":{}}}],["softwaremoduletyp",{"_index":161,"title":{},"description":{"55":{}}}],["specif",{"_index":24,"title":{"4":{},"10":{},"12":{},"14":{},"20":{},"27":{},"30":{},"32":{},"38":{},"39":{},"40":{},"41":{},"42":{},"43":{},"44":{},"45":{},"46":{},"47":{},"48":{},"49":{},"76":{},"90":{},"96":{},"118":{},"150":{},"152":{},"153":{},"154":{}},"description":{"30":{},"40":{},"41":{},"42":{},"43":{},"45":{},"47":{},"48":{},"49":{},"74":{},"75":{},"76":{},"149":{},"152":{},"153":{},"154":{}}}],["spefic",{"_index":27,"title":{},"description":{"5":{},"28":{},"91":{}}}],["start",{"_index":173,"title":{"68":{}},"description":{"68":{}}}],["state",{"_index":104,"title":{"46":{}},"description":{"33":{},"46":{},"72":{},"73":{}}}],["statu",{"_index":74,"title":{"16":{},"17":{},"19":{},"49":{}},"description":{"16":{},"17":{},"19":{}}}],["switch",{"_index":94,"title":{"31":{}},"description":{"31":{}}}],["system",{"_index":186,"title":{"149":{}},"description":{"72":{},"73":{}}}],["tag",{"_index":136,"title":{"44":{},"101":{},"102":{},"103":{},"104":{},"105":{},"108":{},"123":{},"124":{},"125":{},"126":{},"127":{},"129":{},"130":{},"131":{},"132":{},"133":{},"134":{}},"description":{"44":{},"101":{},"102":{},"103":{},"104":{},"108":{},"109":{},"124":{},"125":{},"126":{},"131":{},"132":{}}}],["tag(",{"_index":218,"title":{"109":{}},"description":{}}],["tagid",{"_index":215,"title":{"106":{},"107":{},"110":{},"111":{}},"description":{}}],["target",{"_index":47,"title":{"12":{},"13":{},"20":{},"21":{},"23":{},"24":{},"25":{},"26":{},"27":{},"28":{},"29":{},"30":{},"32":{},"34":{},"36":{},"37":{},"38":{},"39":{},"40":{},"41":{},"42":{},"43":{},"44":{},"45":{},"46":{},"47":{},"48":{},"49":{},"76":{},"77":{},"78":{},"79":{},"80":{},"81":{},"82":{},"84":{},"85":{},"101":{},"102":{},"103":{},"104":{},"105":{},"107":{},"108":{},"109":{},"111":{},"112":{},"113":{},"114":{},"115":{},"116":{},"117":{},"118":{},"119":{},"120":{}},"description":{"11":{},"12":{},"13":{},"20":{},"21":{},"23":{},"24":{},"25":{},"26":{},"30":{},"34":{},"35":{},"36":{},"37":{},"38":{},"40":{},"41":{},"42":{},"43":{},"44":{},"45":{},"46":{},"47":{},"48":{},"49":{},"76":{},"77":{},"78":{},"79":{},"80":{},"81":{},"82":{},"83":{},"84":{},"85":{},"101":{},"102":{},"103":{},"104":{},"105":{},"106":{},"107":{},"108":{},"109":{},"110":{},"111":{},"112":{},"113":{},"114":{},"115":{},"116":{},"117":{},"119":{},"120":{}}}],["target(",{"_index":110,"title":{"35":{},"106":{},"110":{}},"description":{}}],["tenant",{"_index":247,"title":{"150":{},"151":{},"152":{},"153":{},"154":{}},"description":{"149":{},"150":{},"151":{},"152":{},"153":{},"154":{}}}],["tenant_configur",{"_index":252,"title":{},"description":{"151":{},"153":{},"154":{}}}],["transfer",{"_index":102,"title":{},"description":{"33":{}}}],["trigger",{"_index":131,"title":{"67":{}},"description":{"41":{},"67":{}}}],["type",{"_index":112,"title":{"36":{},"37":{},"55":{},"56":{},"57":{},"58":{},"59":{},"60":{},"77":{},"78":{},"79":{},"80":{},"81":{},"82":{},"83":{},"84":{},"85":{},"135":{},"136":{},"137":{},"138":{},"139":{},"140":{},"141":{},"142":{},"143":{},"144":{},"145":{},"146":{},"147":{},"148":{}},"description":{"36":{},"37":{},"56":{},"57":{},"58":{},"59":{},"60":{},"77":{},"78":{},"79":{},"80":{},"81":{},"82":{},"83":{},"84":{},"85":{},"136":{},"137":{},"138":{},"139":{},"140":{},"141":{},"142":{},"143":{},"144":{},"145":{},"146":{},"147":{},"148":{}}}],["type.not",{"_index":239,"title":{},"description":{"142":{},"144":{}}}],["unassign",{"_index":114,"title":{"37":{},"107":{},"111":{},"130":{},"134":{}},"description":{"107":{},"111":{},"130":{},"134":{}}}],["unchang",{"_index":119,"title":{},"description":{"40":{}}}],["updat",{"_index":16,"title":{"2":{},"5":{},"25":{},"28":{},"57":{},"63":{},"79":{},"88":{},"91":{},"103":{},"114":{},"125":{},"137":{},"151":{},"153":{}},"description":{"2":{},"5":{},"25":{},"28":{},"36":{},"63":{},"91":{},"103":{},"114":{},"125":{},"151":{}}}],["update_repositori",{"_index":17,"title":{},"description":{"2":{},"5":{},"6":{},"11":{},"15":{},"22":{},"28":{},"29":{},"57":{},"88":{},"91":{},"92":{},"96":{},"137":{},"142":{},"144":{},"146":{}}}],["update_rollout",{"_index":166,"title":{},"description":{"63":{},"67":{}}}],["update_target",{"_index":41,"title":{},"description":{"10":{},"11":{},"13":{},"25":{},"31":{},"32":{},"33":{},"36":{},"37":{},"39":{},"40":{},"41":{},"43":{},"79":{},"84":{},"85":{},"114":{},"119":{},"120":{}}}],["upload",{"_index":211,"title":{"98":{}},"description":{"98":{}}}],["us",{"_index":241,"title":{},"description":{"142":{},"144":{},"146":{},"154":{}}}],["user",{"_index":53,"title":{},"description":{"11":{},"53":{}}}],["valid",{"_index":44,"title":{},"description":{"11":{},"13":{},"53":{}}}],["validatebasicauth",{"_index":159,"title":{"54":{}},"description":{}}],["valu",{"_index":23,"title":{"4":{},"5":{},"27":{},"28":{},"90":{},"91":{},"150":{},"152":{},"153":{},"154":{}},"description":{"4":{},"5":{},"27":{},"28":{},"90":{},"91":{},"152":{},"153":{},"154":{}}}],["wait",{"_index":99,"title":{"33":{}},"description":{"33":{}}}],["waiting_for_approv",{"_index":188,"title":{},"description":{"72":{},"73":{}}}],["waiting_for_confirm",{"_index":107,"title":{},"description":{"33":{}}}],["well",{"_index":127,"title":{},"description":{"41":{}}}],["whole",{"_index":251,"title":{},"description":{"151":{}}}],["within",{"_index":33,"title":{},"description":{"8":{},"88":{},"89":{}}}],["workflow",{"_index":184,"title":{},"description":{"72":{},"73":{}}}]],"pipeline":[]}},"options":{}};
|
||
|
||
var container = document.getElementById('redoc');
|
||
Redoc.hydrate(__redoc_state, container);
|
||
|
||
</script>
|
||
</body>
|
||
|
||
</html>
|