@approvio/api 0.0.6 → 0.0.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/add-group-entities-request.d.ts +1 -1
- package/dist/and-rule.d.ts +1 -1
- package/dist/api-error-details-inner.d.ts +1 -1
- package/dist/api-error-details-inner.js +1 -1
- package/dist/api-error.d.ts +1 -1
- package/dist/approval-rule.d.ts +1 -1
- package/dist/auth-message-response.d.ts +17 -0
- package/dist/auth-message-response.js +14 -0
- package/dist/auth-message-response.js.map +1 -0
- package/dist/bound-role.d.ts +26 -0
- package/dist/bound-role.js +3 -0
- package/dist/bound-role.js.map +1 -0
- package/dist/can-vote-response.d.ts +1 -1
- package/dist/can-vote-response.js +1 -1
- package/dist/email-action.d.ts +1 -1
- package/dist/email-action.js +1 -1
- package/dist/entity-membership-add.d.ts +1 -1
- package/dist/entity-membership-remove.d.ts +1 -1
- package/dist/entity-reference.d.ts +1 -1
- package/dist/entity-reference.js +1 -1
- package/dist/group-create.d.ts +1 -1
- package/dist/group-create.js +1 -1
- package/dist/group-membership.d.ts +1 -1
- package/dist/group-requirement-rule.d.ts +1 -1
- package/dist/group-requirement-rule.js +1 -1
- package/dist/group-scope.d.ts +27 -0
- package/dist/group-scope.js +21 -0
- package/dist/group-scope.js.map +1 -0
- package/dist/group.d.ts +1 -1
- package/dist/group.js +1 -1
- package/dist/index.d.ts +20 -0
- package/dist/index.html +742 -0
- package/dist/index.js +20 -0
- package/dist/index.js.map +1 -1
- package/dist/list-group-entities-200-response.d.ts +1 -1
- package/dist/list-groups-200-response.d.ts +1 -1
- package/dist/list-organization-admins-200-response.d.ts +17 -0
- package/dist/list-organization-admins-200-response.js +3 -0
- package/dist/list-organization-admins-200-response.js.map +1 -0
- package/dist/list-organization-admins-for-org-200-response.d.ts +17 -0
- package/dist/list-organization-admins-for-org-200-response.js +3 -0
- package/dist/list-organization-admins-for-org-200-response.js.map +1 -0
- package/dist/list-spaces-200-response.d.ts +17 -0
- package/dist/list-spaces-200-response.js +3 -0
- package/dist/list-spaces-200-response.js.map +1 -0
- package/dist/list-users-200-response.d.ts +1 -1
- package/dist/list-workflow-templates-200-response.d.ts +1 -1
- package/dist/list-workflows-200-response.d.ts +1 -1
- package/dist/models.d.ts +4 -0
- package/dist/models.js +4 -0
- package/dist/models.js.map +1 -1
- package/dist/or-rule.d.ts +1 -1
- package/dist/org-scope.d.ts +23 -0
- package/dist/org-scope.js +21 -0
- package/dist/org-scope.js.map +1 -0
- package/dist/organization-admin-create.d.ts +17 -0
- package/dist/organization-admin-create.js +14 -0
- package/dist/organization-admin-create.js.map +1 -0
- package/dist/organization-admin-remove.d.ts +17 -0
- package/dist/organization-admin-remove.js +14 -0
- package/dist/organization-admin-remove.js.map +1 -0
- package/dist/organization-admin.d.ts +25 -0
- package/dist/organization-admin.js +14 -0
- package/dist/organization-admin.js.map +1 -0
- package/dist/pagination.d.ts +1 -1
- package/dist/pagination.js +1 -1
- package/dist/remove-group-entities-request.d.ts +1 -1
- package/dist/role-scope.d.ts +24 -0
- package/dist/role-scope.js +3 -0
- package/dist/role-scope.js.map +1 -0
- package/dist/role.d.ts +26 -0
- package/dist/role.js +3 -0
- package/dist/role.js.map +1 -0
- package/dist/space-create.d.ts +21 -0
- package/dist/space-create.js +14 -0
- package/dist/space-create.js.map +1 -0
- package/dist/space-scope.d.ts +27 -0
- package/dist/space-scope.js +21 -0
- package/dist/space-scope.js.map +1 -0
- package/dist/space.d.ts +33 -0
- package/dist/space.js +14 -0
- package/dist/space.js.map +1 -0
- package/dist/token-request.d.ts +21 -0
- package/dist/token-request.js +14 -0
- package/dist/token-request.js.map +1 -0
- package/dist/token-response.d.ts +17 -0
- package/dist/token-response.js +14 -0
- package/dist/token-response.js.map +1 -0
- package/dist/user-create.d.ts +1 -1
- package/dist/user-create.js +1 -1
- package/dist/user-summary.d.ts +1 -1
- package/dist/user-summary.js +1 -1
- package/dist/user.d.ts +1 -1
- package/dist/user.js +1 -1
- package/dist/vote-approve.d.ts +2 -2
- package/dist/vote-approve.js +1 -1
- package/dist/vote-veto.d.ts +1 -1
- package/dist/vote-veto.js +1 -1
- package/dist/vote-withdraw.d.ts +1 -1
- package/dist/vote-withdraw.js +1 -1
- package/dist/workflow-action.d.ts +1 -1
- package/dist/workflow-create.d.ts +1 -1
- package/dist/workflow-create.js +1 -1
- package/dist/workflow-ref.d.ts +1 -1
- package/dist/workflow-template-create.d.ts +1 -1
- package/dist/workflow-template-delete.d.ts +17 -0
- package/dist/workflow-template-delete.js +14 -0
- package/dist/workflow-template-delete.js.map +1 -0
- package/dist/workflow-template-deprecate.d.ts +17 -0
- package/dist/workflow-template-deprecate.js +14 -0
- package/dist/workflow-template-deprecate.js.map +1 -0
- package/dist/workflow-template-scope.d.ts +27 -0
- package/dist/workflow-template-scope.js +21 -0
- package/dist/workflow-template-scope.js.map +1 -0
- package/dist/workflow-template-summary.d.ts +5 -1
- package/dist/workflow-template-summary.js +1 -1
- package/dist/workflow-template-update.d.ts +5 -5
- package/dist/workflow-template.d.ts +21 -1
- package/dist/workflow-template.js +9 -0
- package/dist/workflow-template.js.map +1 -1
- package/dist/workflow-vote-request-vote-type.d.ts +1 -1
- package/dist/workflow-vote-request.d.ts +1 -1
- package/dist/workflow.d.ts +1 -1
- package/package.json +3 -1
package/dist/index.html
ADDED
|
@@ -0,0 +1,742 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
|
|
4
|
+
<head>
|
|
5
|
+
<meta charset="utf8" />
|
|
6
|
+
<title>Workflow Approval System API</title>
|
|
7
|
+
<!-- needed for adaptive design -->
|
|
8
|
+
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
9
|
+
<style>
|
|
10
|
+
body {
|
|
11
|
+
padding: 0;
|
|
12
|
+
margin: 0;
|
|
13
|
+
}
|
|
14
|
+
</style>
|
|
15
|
+
<script src="https://cdn.redocly.com/redoc/v2.5.0/bundles/redoc.standalone.js"></script><style data-styled="true" data-styled-version="6.1.19">.fqkwbU{width:calc(100% - 40%);padding:0 40px;}/*!sc*/
|
|
16
|
+
@media print,screen and (max-width: 75rem){.fqkwbU{width:100%;padding:40px 40px;}}/*!sc*/
|
|
17
|
+
.dCzIPc{width:calc(100% - 40%);padding:0 40px;}/*!sc*/
|
|
18
|
+
@media print,screen and (max-width: 75rem){.dCzIPc{width:100%;padding:0px 40px;}}/*!sc*/
|
|
19
|
+
data-styled.g4[id="sc-ggWZvA"]{content:"fqkwbU,dCzIPc,"}/*!sc*/
|
|
20
|
+
.bPmFpz{padding:40px 0;}/*!sc*/
|
|
21
|
+
.bPmFpz:last-child{min-height:calc(100vh + 1px);}/*!sc*/
|
|
22
|
+
.bPmFpz>.bPmFpz:last-child{min-height:initial;}/*!sc*/
|
|
23
|
+
@media print,screen and (max-width: 75rem){.bPmFpz{padding:0;}}/*!sc*/
|
|
24
|
+
.gHrCVQ{padding:40px 0;position:relative;}/*!sc*/
|
|
25
|
+
.gHrCVQ:last-child{min-height:calc(100vh + 1px);}/*!sc*/
|
|
26
|
+
.gHrCVQ>.gHrCVQ:last-child{min-height:initial;}/*!sc*/
|
|
27
|
+
@media print,screen and (max-width: 75rem){.gHrCVQ{padding:0;}}/*!sc*/
|
|
28
|
+
.gHrCVQ: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*/
|
|
29
|
+
data-styled.g5[id="sc-dTvVRJ"]{content:"bPmFpz,gHrCVQ,"}/*!sc*/
|
|
30
|
+
.bDYKKx{width:40%;color:#ffffff;background-color:#263238;padding:0 40px;}/*!sc*/
|
|
31
|
+
@media print,screen and (max-width: 75rem){.bDYKKx{width:100%;padding:40px 40px;}}/*!sc*/
|
|
32
|
+
data-styled.g6[id="sc-jwTyAe"]{content:"bDYKKx,"}/*!sc*/
|
|
33
|
+
.FFPsr{background-color:#263238;}/*!sc*/
|
|
34
|
+
data-styled.g7[id="sc-hjsuWn"]{content:"FFPsr,"}/*!sc*/
|
|
35
|
+
.gkiSyE{display:flex;width:100%;padding:0;}/*!sc*/
|
|
36
|
+
@media print,screen and (max-width: 75rem){.gkiSyE{flex-direction:column;}}/*!sc*/
|
|
37
|
+
data-styled.g8[id="sc-jJLAfE"]{content:"gkiSyE,"}/*!sc*/
|
|
38
|
+
.wYHiz{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.85714em;line-height:1.6em;color:#333333;}/*!sc*/
|
|
39
|
+
data-styled.g9[id="sc-hwkwBN"]{content:"wYHiz,"}/*!sc*/
|
|
40
|
+
.iFSqkw{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.57143em;line-height:1.6em;color:#333333;margin:0 0 20px;}/*!sc*/
|
|
41
|
+
data-styled.g10[id="sc-kNOymR"]{content:"iFSqkw,"}/*!sc*/
|
|
42
|
+
.drJHMo{color:#ffffff;}/*!sc*/
|
|
43
|
+
data-styled.g12[id="sc-lgpSej"]{content:"drJHMo,"}/*!sc*/
|
|
44
|
+
.czjApA{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*/
|
|
45
|
+
data-styled.g13[id="sc-eqYatC"]{content:"czjApA,"}/*!sc*/
|
|
46
|
+
.fRdsOi{cursor:pointer;margin-left:-20px;padding:0;line-height:1;width:20px;display:inline-block;outline:0;}/*!sc*/
|
|
47
|
+
.fRdsOi: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*/
|
|
48
|
+
h1:hover>.fRdsOi::before,h2:hover>.fRdsOi::before,.fRdsOi:hover::before{visibility:visible;}/*!sc*/
|
|
49
|
+
data-styled.g14[id="sc-kcLKEh"]{content:"fRdsOi,"}/*!sc*/
|
|
50
|
+
.dUlzCe{height:18px;width:18px;min-width:18px;vertical-align:middle;float:right;transition:transform 0.2s ease-out;transform:rotateZ(-90deg);}/*!sc*/
|
|
51
|
+
.FtowP{height:1.3em;width:1.3em;min-width:1.3em;vertical-align:middle;transition:transform 0.2s ease-out;transform:rotateZ(-90deg);}/*!sc*/
|
|
52
|
+
.cGxVlA{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*/
|
|
53
|
+
.cGxVlA polygon{fill:#1d8127;}/*!sc*/
|
|
54
|
+
.jKYZgc{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*/
|
|
55
|
+
.jKYZgc polygon{fill:#d41f1c;}/*!sc*/
|
|
56
|
+
.iuNpUs{height:20px;width:20px;min-width:20px;vertical-align:middle;float:right;transition:transform 0.2s ease-out;transform:rotateZ(0);}/*!sc*/
|
|
57
|
+
.iuNpUs polygon{fill:white;}/*!sc*/
|
|
58
|
+
.dOPmTa{height:18px;width:18px;min-width:18px;vertical-align:middle;transition:transform 0.2s ease-out;transform:rotateZ(-90deg);}/*!sc*/
|
|
59
|
+
data-styled.g15[id="sc-dntSTA"]{content:"dUlzCe,FtowP,cGxVlA,jKYZgc,iuNpUs,dOPmTa,"}/*!sc*/
|
|
60
|
+
.gdmNWp{border-left:1px solid #7c7cbb;box-sizing:border-box;position:relative;padding:10px 10px 10px 0;}/*!sc*/
|
|
61
|
+
@media screen and (max-width: 50rem){.gdmNWp{display:block;overflow:hidden;}}/*!sc*/
|
|
62
|
+
tr:first-of-type>.gdmNWp,tr.last>.gdmNWp{border-left-width:0;background-position:top left;background-repeat:no-repeat;background-size:1px 100%;}/*!sc*/
|
|
63
|
+
tr:first-of-type>.gdmNWp{background-image:linear-gradient(
|
|
64
|
+
to bottom,
|
|
65
|
+
transparent 0%,
|
|
66
|
+
transparent 22px,
|
|
67
|
+
#7c7cbb 22px,
|
|
68
|
+
#7c7cbb 100%
|
|
69
|
+
);}/*!sc*/
|
|
70
|
+
tr.last>.gdmNWp{background-image:linear-gradient(
|
|
71
|
+
to bottom,
|
|
72
|
+
#7c7cbb 0%,
|
|
73
|
+
#7c7cbb 22px,
|
|
74
|
+
transparent 22px,
|
|
75
|
+
transparent 100%
|
|
76
|
+
);}/*!sc*/
|
|
77
|
+
tr.last+tr>.gdmNWp{border-left-color:transparent;}/*!sc*/
|
|
78
|
+
tr.last:first-child>.gdmNWp{background:none;border-left-color:transparent;}/*!sc*/
|
|
79
|
+
data-styled.g18[id="sc-kCuUfV"]{content:"gdmNWp,"}/*!sc*/
|
|
80
|
+
.dFOJWJ{vertical-align:top;line-height:20px;white-space:nowrap;font-size:13px;font-family:Courier,monospace;}/*!sc*/
|
|
81
|
+
.dFOJWJ.deprecated{text-decoration:line-through;color:#707070;}/*!sc*/
|
|
82
|
+
data-styled.g20[id="sc-fbQrwq"]{content:"dFOJWJ,"}/*!sc*/
|
|
83
|
+
.ixGaBD{border-bottom:1px solid #9fb4be;padding:10px 0;width:75%;box-sizing:border-box;}/*!sc*/
|
|
84
|
+
tr.expanded .ixGaBD{border-bottom:none;}/*!sc*/
|
|
85
|
+
@media screen and (max-width: 50rem){.ixGaBD{padding:0 20px;border-bottom:none;border-left:1px solid #7c7cbb;}tr.last>.ixGaBD{border-left:none;}}/*!sc*/
|
|
86
|
+
data-styled.g21[id="sc-gGKoUb"]{content:"ixGaBD,"}/*!sc*/
|
|
87
|
+
.cteAyA{color:#7c7cbb;font-family:Courier,monospace;margin-right:10px;}/*!sc*/
|
|
88
|
+
.cteAyA::before{content:'';display:inline-block;vertical-align:middle;width:10px;height:1px;background:#7c7cbb;}/*!sc*/
|
|
89
|
+
.cteAyA::after{content:'';display:inline-block;vertical-align:middle;width:1px;background:#7c7cbb;height:7px;}/*!sc*/
|
|
90
|
+
data-styled.g22[id="sc-hwddKA"]{content:"cteAyA,"}/*!sc*/
|
|
91
|
+
.icJLQx{border-collapse:separate;border-radius:3px;font-size:14px;border-spacing:0;width:100%;}/*!sc*/
|
|
92
|
+
.icJLQx >tr{vertical-align:middle;}/*!sc*/
|
|
93
|
+
@media screen and (max-width: 50rem){.icJLQx{display:block;}.icJLQx >tr,.icJLQx >tbody>tr{display:block;}}/*!sc*/
|
|
94
|
+
@media screen and (max-width: 50rem) and (-ms-high-contrast:none){.icJLQx td{float:left;width:100%;}}/*!sc*/
|
|
95
|
+
.icJLQx .sc-jaXbil,.icJLQx .sc-jaXbil .sc-jaXbil .sc-jaXbil,.icJLQx .sc-jaXbil .sc-jaXbil .sc-jaXbil .sc-jaXbil .sc-jaXbil{margin:1em;margin-right:0;background:#fafafa;}/*!sc*/
|
|
96
|
+
.icJLQx .sc-jaXbil .sc-jaXbil,.icJLQx .sc-jaXbil .sc-jaXbil .sc-jaXbil .sc-jaXbil,.icJLQx .sc-jaXbil .sc-jaXbil .sc-jaXbil .sc-jaXbil .sc-jaXbil .sc-jaXbil{background:#ffffff;}/*!sc*/
|
|
97
|
+
data-styled.g24[id="sc-eqNDNG"]{content:"icJLQx,"}/*!sc*/
|
|
98
|
+
.fyxuKi >ul{list-style:none;padding:0;margin:0;margin:0 -5px;}/*!sc*/
|
|
99
|
+
.fyxuKi >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*/
|
|
100
|
+
.fyxuKi >ul >li.react-tabs__tab--selected{color:#333333;background:#ffffff;}/*!sc*/
|
|
101
|
+
.fyxuKi >ul >li.react-tabs__tab--selected:focus{outline:auto;}/*!sc*/
|
|
102
|
+
.fyxuKi >ul >li:only-child{flex:none;min-width:100px;}/*!sc*/
|
|
103
|
+
.fyxuKi >ul >li.tab-success{color:#1d8127;}/*!sc*/
|
|
104
|
+
.fyxuKi >ul >li.tab-redirect{color:#ffa500;}/*!sc*/
|
|
105
|
+
.fyxuKi >ul >li.tab-info{color:#87ceeb;}/*!sc*/
|
|
106
|
+
.fyxuKi >ul >li.tab-error{color:#d41f1c;}/*!sc*/
|
|
107
|
+
.fyxuKi >.react-tabs__tab-panel{background:#11171a;}/*!sc*/
|
|
108
|
+
.fyxuKi >.react-tabs__tab-panel>div,.fyxuKi >.react-tabs__tab-panel>pre{padding:20px;margin:0;}/*!sc*/
|
|
109
|
+
.fyxuKi >.react-tabs__tab-panel>div>pre{padding:0;}/*!sc*/
|
|
110
|
+
data-styled.g30[id="sc-cOpnSz"]{content:"fyxuKi,"}/*!sc*/
|
|
111
|
+
.kIppRw code[class*='language-'],.kIppRw 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*/
|
|
112
|
+
@media print{.kIppRw code[class*='language-'],.kIppRw pre[class*='language-']{text-shadow:none;}}/*!sc*/
|
|
113
|
+
.kIppRw pre[class*='language-']{padding:1em;margin:0.5em 0;overflow:auto;}/*!sc*/
|
|
114
|
+
.kIppRw .token.comment,.kIppRw .token.prolog,.kIppRw .token.doctype,.kIppRw .token.cdata{color:hsl(30, 20%, 50%);}/*!sc*/
|
|
115
|
+
.kIppRw .token.punctuation{opacity:0.7;}/*!sc*/
|
|
116
|
+
.kIppRw .namespace{opacity:0.7;}/*!sc*/
|
|
117
|
+
.kIppRw .token.property,.kIppRw .token.tag,.kIppRw .token.number,.kIppRw .token.constant,.kIppRw .token.symbol{color:#4a8bb3;}/*!sc*/
|
|
118
|
+
.kIppRw .token.boolean{color:#e64441;}/*!sc*/
|
|
119
|
+
.kIppRw .token.selector,.kIppRw .token.attr-name,.kIppRw .token.string,.kIppRw .token.char,.kIppRw .token.builtin,.kIppRw .token.inserted{color:#a0fbaa;}/*!sc*/
|
|
120
|
+
.kIppRw .token.selector+a,.kIppRw .token.attr-name+a,.kIppRw .token.string+a,.kIppRw .token.char+a,.kIppRw .token.builtin+a,.kIppRw .token.inserted+a,.kIppRw .token.selector+a:visited,.kIppRw .token.attr-name+a:visited,.kIppRw .token.string+a:visited,.kIppRw .token.char+a:visited,.kIppRw .token.builtin+a:visited,.kIppRw .token.inserted+a:visited{color:#4ed2ba;text-decoration:underline;}/*!sc*/
|
|
121
|
+
.kIppRw .token.property.string{color:white;}/*!sc*/
|
|
122
|
+
.kIppRw .token.operator,.kIppRw .token.entity,.kIppRw .token.url,.kIppRw .token.variable{color:hsl(40, 90%, 60%);}/*!sc*/
|
|
123
|
+
.kIppRw .token.atrule,.kIppRw .token.attr-value,.kIppRw .token.keyword{color:hsl(350, 40%, 70%);}/*!sc*/
|
|
124
|
+
.kIppRw .token.regex,.kIppRw .token.important{color:#e90;}/*!sc*/
|
|
125
|
+
.kIppRw .token.important,.kIppRw .token.bold{font-weight:bold;}/*!sc*/
|
|
126
|
+
.kIppRw .token.italic{font-style:italic;}/*!sc*/
|
|
127
|
+
.kIppRw .token.entity{cursor:help;}/*!sc*/
|
|
128
|
+
.kIppRw .token.deleted{color:red;}/*!sc*/
|
|
129
|
+
data-styled.g32[id="sc-eVqvcJ"]{content:"kIppRw,"}/*!sc*/
|
|
130
|
+
.bBWkcI{opacity:0.7;transition:opacity 0.3s ease;text-align:right;}/*!sc*/
|
|
131
|
+
.bBWkcI:focus-within{opacity:1;}/*!sc*/
|
|
132
|
+
.bBWkcI >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*/
|
|
133
|
+
.bBWkcI >button :hover,.bBWkcI >button :focus{background:rgba(255, 255, 255, 0.1);}/*!sc*/
|
|
134
|
+
data-styled.g33[id="sc-bbbBoY"]{content:"bBWkcI,"}/*!sc*/
|
|
135
|
+
.ghzOpX{position:relative;}/*!sc*/
|
|
136
|
+
data-styled.g37[id="sc-eknHtZ"]{content:"ghzOpX,"}/*!sc*/
|
|
137
|
+
.cFlAeY{margin-left:10px;text-transform:none;font-size:0.929em;color:black;}/*!sc*/
|
|
138
|
+
data-styled.g41[id="sc-dNFkOE"]{content:"cFlAeY,"}/*!sc*/
|
|
139
|
+
.kbZred{font-family:Roboto,sans-serif;font-weight:400;line-height:1.5em;}/*!sc*/
|
|
140
|
+
.kbZred p:last-child{margin-bottom:0;}/*!sc*/
|
|
141
|
+
.kbZred h1{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.85714em;line-height:1.6em;color:#32329f;margin-top:0;}/*!sc*/
|
|
142
|
+
.kbZred h2{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.57143em;line-height:1.6em;color:#333333;}/*!sc*/
|
|
143
|
+
.kbZred 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*/
|
|
144
|
+
.kbZred 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*/
|
|
145
|
+
.kbZred pre code{background-color:transparent;color:white;padding:0;}/*!sc*/
|
|
146
|
+
.kbZred pre code:before,.kbZred pre code:after{content:none;}/*!sc*/
|
|
147
|
+
.kbZred blockquote{margin:0;margin-bottom:1em;padding:0 15px;color:#777;border-left:4px solid #ddd;}/*!sc*/
|
|
148
|
+
.kbZred img{max-width:100%;box-sizing:content-box;}/*!sc*/
|
|
149
|
+
.kbZred ul,.kbZred ol{padding-left:2em;margin:0;margin-bottom:1em;}/*!sc*/
|
|
150
|
+
.kbZred ul ul,.kbZred ol ul,.kbZred ul ol,.kbZred ol ol{margin-bottom:0;margin-top:0;}/*!sc*/
|
|
151
|
+
.kbZred 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*/
|
|
152
|
+
.kbZred table tr{background-color:#fff;border-top:1px solid #ccc;}/*!sc*/
|
|
153
|
+
.kbZred table tr:nth-child(2n){background-color:#fafafa;}/*!sc*/
|
|
154
|
+
.kbZred table th,.kbZred table td{padding:6px 13px;border:1px solid #ddd;}/*!sc*/
|
|
155
|
+
.kbZred table th{text-align:left;font-weight:bold;}/*!sc*/
|
|
156
|
+
.kbZred .share-link{cursor:pointer;margin-left:-20px;padding:0;line-height:1;width:20px;display:inline-block;outline:0;}/*!sc*/
|
|
157
|
+
.kbZred .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*/
|
|
158
|
+
.kbZred h1:hover>.share-link::before,.kbZred h2:hover>.share-link::before,.kbZred .share-link:hover::before{visibility:visible;}/*!sc*/
|
|
159
|
+
.kbZred a{text-decoration:auto;color:#32329f;}/*!sc*/
|
|
160
|
+
.kbZred a:visited{color:#32329f;}/*!sc*/
|
|
161
|
+
.kbZred a:hover{color:#6868cf;text-decoration:auto;}/*!sc*/
|
|
162
|
+
.drqpJr{font-family:Roboto,sans-serif;font-weight:400;line-height:1.5em;}/*!sc*/
|
|
163
|
+
.drqpJr p:last-child{margin-bottom:0;}/*!sc*/
|
|
164
|
+
.drqpJr p:first-child{margin-top:0;}/*!sc*/
|
|
165
|
+
.drqpJr p:last-child{margin-bottom:0;}/*!sc*/
|
|
166
|
+
.drqpJr h1{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.85714em;line-height:1.6em;color:#32329f;margin-top:0;}/*!sc*/
|
|
167
|
+
.drqpJr h2{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.57143em;line-height:1.6em;color:#333333;}/*!sc*/
|
|
168
|
+
.drqpJr 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*/
|
|
169
|
+
.drqpJr 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*/
|
|
170
|
+
.drqpJr pre code{background-color:transparent;color:white;padding:0;}/*!sc*/
|
|
171
|
+
.drqpJr pre code:before,.drqpJr pre code:after{content:none;}/*!sc*/
|
|
172
|
+
.drqpJr blockquote{margin:0;margin-bottom:1em;padding:0 15px;color:#777;border-left:4px solid #ddd;}/*!sc*/
|
|
173
|
+
.drqpJr img{max-width:100%;box-sizing:content-box;}/*!sc*/
|
|
174
|
+
.drqpJr ul,.drqpJr ol{padding-left:2em;margin:0;margin-bottom:1em;}/*!sc*/
|
|
175
|
+
.drqpJr ul ul,.drqpJr ol ul,.drqpJr ul ol,.drqpJr ol ol{margin-bottom:0;margin-top:0;}/*!sc*/
|
|
176
|
+
.drqpJr 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*/
|
|
177
|
+
.drqpJr table tr{background-color:#fff;border-top:1px solid #ccc;}/*!sc*/
|
|
178
|
+
.drqpJr table tr:nth-child(2n){background-color:#fafafa;}/*!sc*/
|
|
179
|
+
.drqpJr table th,.drqpJr table td{padding:6px 13px;border:1px solid #ddd;}/*!sc*/
|
|
180
|
+
.drqpJr table th{text-align:left;font-weight:bold;}/*!sc*/
|
|
181
|
+
.drqpJr .share-link{cursor:pointer;margin-left:-20px;padding:0;line-height:1;width:20px;display:inline-block;outline:0;}/*!sc*/
|
|
182
|
+
.drqpJr .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*/
|
|
183
|
+
.drqpJr h1:hover>.share-link::before,.drqpJr h2:hover>.share-link::before,.drqpJr .share-link:hover::before{visibility:visible;}/*!sc*/
|
|
184
|
+
.drqpJr a{text-decoration:auto;color:#32329f;}/*!sc*/
|
|
185
|
+
.drqpJr a:visited{color:#32329f;}/*!sc*/
|
|
186
|
+
.drqpJr a:hover{color:#6868cf;text-decoration:auto;}/*!sc*/
|
|
187
|
+
.jnwENr{font-family:Roboto,sans-serif;font-weight:400;line-height:1.5em;}/*!sc*/
|
|
188
|
+
.jnwENr p:last-child{margin-bottom:0;}/*!sc*/
|
|
189
|
+
.jnwENr p:first-child{margin-top:0;}/*!sc*/
|
|
190
|
+
.jnwENr p:last-child{margin-bottom:0;}/*!sc*/
|
|
191
|
+
.jnwENr p{display:inline-block;}/*!sc*/
|
|
192
|
+
.jnwENr h1{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.85714em;line-height:1.6em;color:#32329f;margin-top:0;}/*!sc*/
|
|
193
|
+
.jnwENr h2{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.57143em;line-height:1.6em;color:#333333;}/*!sc*/
|
|
194
|
+
.jnwENr 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*/
|
|
195
|
+
.jnwENr 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*/
|
|
196
|
+
.jnwENr pre code{background-color:transparent;color:white;padding:0;}/*!sc*/
|
|
197
|
+
.jnwENr pre code:before,.jnwENr pre code:after{content:none;}/*!sc*/
|
|
198
|
+
.jnwENr blockquote{margin:0;margin-bottom:1em;padding:0 15px;color:#777;border-left:4px solid #ddd;}/*!sc*/
|
|
199
|
+
.jnwENr img{max-width:100%;box-sizing:content-box;}/*!sc*/
|
|
200
|
+
.jnwENr ul,.jnwENr ol{padding-left:2em;margin:0;margin-bottom:1em;}/*!sc*/
|
|
201
|
+
.jnwENr ul ul,.jnwENr ol ul,.jnwENr ul ol,.jnwENr ol ol{margin-bottom:0;margin-top:0;}/*!sc*/
|
|
202
|
+
.jnwENr 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*/
|
|
203
|
+
.jnwENr table tr{background-color:#fff;border-top:1px solid #ccc;}/*!sc*/
|
|
204
|
+
.jnwENr table tr:nth-child(2n){background-color:#fafafa;}/*!sc*/
|
|
205
|
+
.jnwENr table th,.jnwENr table td{padding:6px 13px;border:1px solid #ddd;}/*!sc*/
|
|
206
|
+
.jnwENr table th{text-align:left;font-weight:bold;}/*!sc*/
|
|
207
|
+
.jnwENr .share-link{cursor:pointer;margin-left:-20px;padding:0;line-height:1;width:20px;display:inline-block;outline:0;}/*!sc*/
|
|
208
|
+
.jnwENr .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*/
|
|
209
|
+
.jnwENr h1:hover>.share-link::before,.jnwENr h2:hover>.share-link::before,.jnwENr .share-link:hover::before{visibility:visible;}/*!sc*/
|
|
210
|
+
.jnwENr a{text-decoration:auto;color:#32329f;}/*!sc*/
|
|
211
|
+
.jnwENr a:visited{color:#32329f;}/*!sc*/
|
|
212
|
+
.jnwENr a:hover{color:#6868cf;text-decoration:auto;}/*!sc*/
|
|
213
|
+
data-styled.g42[id="sc-fszimp"]{content:"kbZred,drqpJr,jnwENr,"}/*!sc*/
|
|
214
|
+
.ljKHqG{display:inline;}/*!sc*/
|
|
215
|
+
data-styled.g43[id="sc-etsjJW"]{content:"ljKHqG,"}/*!sc*/
|
|
216
|
+
.iNCOCX{position:relative;}/*!sc*/
|
|
217
|
+
data-styled.g44[id="sc-fYmhhH"]{content:"iNCOCX,"}/*!sc*/
|
|
218
|
+
.fdRrNy:hover>.sc-bbbBoY{opacity:1;}/*!sc*/
|
|
219
|
+
data-styled.g49[id="sc-dClGHI"]{content:"fdRrNy,"}/*!sc*/
|
|
220
|
+
.dFvLDb{font-family:Courier,monospace;font-size:13px;white-space:pre;contain:content;overflow-x:auto;}/*!sc*/
|
|
221
|
+
.dFvLDb .redoc-json code>.collapser{display:none;pointer-events:none;}/*!sc*/
|
|
222
|
+
.dFvLDb .callback-function{color:gray;}/*!sc*/
|
|
223
|
+
.dFvLDb .collapser:after{content:'-';cursor:pointer;}/*!sc*/
|
|
224
|
+
.dFvLDb .collapsed>.collapser:after{content:'+';cursor:pointer;}/*!sc*/
|
|
225
|
+
.dFvLDb .ellipsis:after{content:' … ';}/*!sc*/
|
|
226
|
+
.dFvLDb .collapsible{margin-left:2em;}/*!sc*/
|
|
227
|
+
.dFvLDb .hoverable{padding-top:1px;padding-bottom:1px;padding-left:2px;padding-right:2px;border-radius:2px;}/*!sc*/
|
|
228
|
+
.dFvLDb .hovered{background-color:rgba(235, 238, 249, 1);}/*!sc*/
|
|
229
|
+
.dFvLDb .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*/
|
|
230
|
+
.dFvLDb .collapser:focus{outline-color:#fff;outline-style:dotted;outline-width:1px;}/*!sc*/
|
|
231
|
+
.dFvLDb ul{list-style-type:none;padding:0px;margin:0px 0px 0px 26px;}/*!sc*/
|
|
232
|
+
.dFvLDb li{position:relative;display:block;}/*!sc*/
|
|
233
|
+
.dFvLDb .hoverable{display:inline-block;}/*!sc*/
|
|
234
|
+
.dFvLDb .selected{outline-style:solid;outline-width:1px;outline-style:dotted;}/*!sc*/
|
|
235
|
+
.dFvLDb .collapsed>.collapsible{display:none;}/*!sc*/
|
|
236
|
+
.dFvLDb .ellipsis{display:none;}/*!sc*/
|
|
237
|
+
.dFvLDb .collapsed>.ellipsis{display:inherit;}/*!sc*/
|
|
238
|
+
data-styled.g50[id="sc-fhfEft"]{content:"dFvLDb,"}/*!sc*/
|
|
239
|
+
.iNRAJK{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*/
|
|
240
|
+
data-styled.g51[id="sc-bAehkN"]{content:"iNRAJK,"}/*!sc*/
|
|
241
|
+
.cXitJ{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*/
|
|
242
|
+
data-styled.g52[id="sc-gahYZc"]{content:"cXitJ,"}/*!sc*/
|
|
243
|
+
.iLdyBp{position:relative;}/*!sc*/
|
|
244
|
+
data-styled.g53[id="sc-bSFBcf"]{content:"iLdyBp,"}/*!sc*/
|
|
245
|
+
.eKKwxo{margin-top:15px;}/*!sc*/
|
|
246
|
+
data-styled.g56[id="sc-blIAwI"]{content:"eKKwxo,"}/*!sc*/
|
|
247
|
+
.kdPQHX.deprecated span.property-name{text-decoration:line-through;color:#707070;}/*!sc*/
|
|
248
|
+
.kdPQHX button{background-color:transparent;border:0;outline:0;font-size:13px;font-family:Courier,monospace;cursor:pointer;padding:0;color:#333333;}/*!sc*/
|
|
249
|
+
.kdPQHX button:focus{font-weight:600;}/*!sc*/
|
|
250
|
+
.kdPQHX .sc-dntSTA{height:1.1em;width:1.1em;}/*!sc*/
|
|
251
|
+
.kdPQHX .sc-dntSTA polygon{fill:#666;}/*!sc*/
|
|
252
|
+
data-styled.g57[id="sc-itBLYH"]{content:"kdPQHX,"}/*!sc*/
|
|
253
|
+
.lhyyLL{vertical-align:middle;font-size:13px;line-height:20px;}/*!sc*/
|
|
254
|
+
data-styled.g58[id="sc-bEjUoa"]{content:"lhyyLL,"}/*!sc*/
|
|
255
|
+
.jYezsP{color:rgba(102,102,102,0.9);}/*!sc*/
|
|
256
|
+
data-styled.g59[id="sc-boKDdR"]{content:"jYezsP,"}/*!sc*/
|
|
257
|
+
.dbKJYq{color:#666;}/*!sc*/
|
|
258
|
+
data-styled.g60[id="sc-fOOuSg"]{content:"dbKJYq,"}/*!sc*/
|
|
259
|
+
.nwQTz{color:#666;word-break:break-word;}/*!sc*/
|
|
260
|
+
data-styled.g61[id="sc-hdBJTi"]{content:"nwQTz,"}/*!sc*/
|
|
261
|
+
.crXmiY{color:#d41f1c;font-size:0.9em;font-weight:normal;margin-left:20px;line-height:1;}/*!sc*/
|
|
262
|
+
data-styled.g62[id="sc-iIvHqT"]{content:"crXmiY,"}/*!sc*/
|
|
263
|
+
.kMQdIk{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*/
|
|
264
|
+
+{margin-left:0;}/*!sc*/
|
|
265
|
+
data-styled.g66[id="sc-dTWiOz"]{content:"kMQdIk,"}/*!sc*/
|
|
266
|
+
.bDfgbe{border-radius:2px;background-color:rgba(104,104,207,0.05);color:rgba(50,50,159,0.9);margin:0 5px;padding:0 5px;border:1px solid rgba(50,50,159,0.1);}/*!sc*/
|
|
267
|
+
+{margin-left:0;}/*!sc*/
|
|
268
|
+
data-styled.g68[id="sc-goiVcJ"]{content:"bDfgbe,"}/*!sc*/
|
|
269
|
+
.hRtRoN:after{content:' and ';font-weight:normal;}/*!sc*/
|
|
270
|
+
.hRtRoN:last-child:after{content:none;}/*!sc*/
|
|
271
|
+
.hRtRoN a{text-decoration:auto;color:#32329f;}/*!sc*/
|
|
272
|
+
.hRtRoN a:visited{color:#32329f;}/*!sc*/
|
|
273
|
+
.hRtRoN a:hover{color:#6868cf;text-decoration:auto;}/*!sc*/
|
|
274
|
+
data-styled.g81[id="sc-hqtLyI"]{content:"hRtRoN,"}/*!sc*/
|
|
275
|
+
.gRXavu{white-space:nowrap;}/*!sc*/
|
|
276
|
+
.gRXavu:after{content:' or ';white-space:pre;}/*!sc*/
|
|
277
|
+
.gRXavu:last-child:after,.gRXavu:only-child:after{content:none;}/*!sc*/
|
|
278
|
+
.gRXavu a{text-decoration:auto;color:#32329f;}/*!sc*/
|
|
279
|
+
.gRXavu a:visited{color:#32329f;}/*!sc*/
|
|
280
|
+
.gRXavu a:hover{color:#6868cf;text-decoration:auto;}/*!sc*/
|
|
281
|
+
data-styled.g82[id="sc-iVnIWt"]{content:"gRXavu,"}/*!sc*/
|
|
282
|
+
.dPSGXF{flex:1 1 auto;cursor:pointer;}/*!sc*/
|
|
283
|
+
data-styled.g83[id="sc-hWgKua"]{content:"dPSGXF,"}/*!sc*/
|
|
284
|
+
.fUkQtw{width:75%;text-overflow:ellipsis;border-radius:4px;overflow:hidden;}/*!sc*/
|
|
285
|
+
@media screen and (max-width: 50rem){.fUkQtw{margin-top:10px;}}/*!sc*/
|
|
286
|
+
data-styled.g84[id="sc-jBaHRL"]{content:"fUkQtw,"}/*!sc*/
|
|
287
|
+
.jCoZLr{display:inline-block;margin:0;}/*!sc*/
|
|
288
|
+
data-styled.g85[id="sc-gFqXPY"]{content:"jCoZLr,"}/*!sc*/
|
|
289
|
+
.deUlC{width:100%;display:flex;margin:1em 0;flex-direction:row;}/*!sc*/
|
|
290
|
+
@media screen and (max-width: 50rem){.deUlC{flex-direction:column;}}/*!sc*/
|
|
291
|
+
data-styled.g86[id="sc-ikkVnJ"]{content:"deUlC,"}/*!sc*/
|
|
292
|
+
.hPcPCj{margin-top:0;margin-bottom:0.5em;}/*!sc*/
|
|
293
|
+
data-styled.g92[id="sc-jCWzJg"]{content:"hPcPCj,"}/*!sc*/
|
|
294
|
+
.NmQLu{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*/
|
|
295
|
+
.NmQLu.get{background-color:#2F8132;}/*!sc*/
|
|
296
|
+
.NmQLu.post{background-color:#186FAF;}/*!sc*/
|
|
297
|
+
.NmQLu.put{background-color:#95507c;}/*!sc*/
|
|
298
|
+
.NmQLu.options{background-color:#947014;}/*!sc*/
|
|
299
|
+
.NmQLu.patch{background-color:#bf581d;}/*!sc*/
|
|
300
|
+
.NmQLu.delete{background-color:#cc3333;}/*!sc*/
|
|
301
|
+
.NmQLu.basic{background-color:#707070;}/*!sc*/
|
|
302
|
+
.NmQLu.link{background-color:#07818F;}/*!sc*/
|
|
303
|
+
.NmQLu.head{background-color:#A23DAD;}/*!sc*/
|
|
304
|
+
.NmQLu.hook{background-color:#32329f;}/*!sc*/
|
|
305
|
+
.NmQLu.schema{background-color:#707070;}/*!sc*/
|
|
306
|
+
data-styled.g100[id="sc-jxYSNo"]{content:"NmQLu,"}/*!sc*/
|
|
307
|
+
.gAPKXX{margin:0;padding:0;}/*!sc*/
|
|
308
|
+
.gAPKXX:first-child{padding-bottom:32px;}/*!sc*/
|
|
309
|
+
.sc-zOxLx .sc-zOxLx{font-size:0.929em;}/*!sc*/
|
|
310
|
+
.dQnkdy{margin:0;padding:0;display:none;}/*!sc*/
|
|
311
|
+
.dQnkdy:first-child{padding-bottom:32px;}/*!sc*/
|
|
312
|
+
.sc-zOxLx .sc-zOxLx{font-size:0.929em;}/*!sc*/
|
|
313
|
+
data-styled.g101[id="sc-zOxLx"]{content:"gAPKXX,dQnkdy,"}/*!sc*/
|
|
314
|
+
.ixknQI{list-style:none inside none;overflow:hidden;text-overflow:ellipsis;padding:0;}/*!sc*/
|
|
315
|
+
data-styled.g102[id="sc-cgHfjM"]{content:"ixknQI,"}/*!sc*/
|
|
316
|
+
.lgPGwq{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*/
|
|
317
|
+
.lgPGwq:hover{color:#32329f;background-color:#e1e1e1;}/*!sc*/
|
|
318
|
+
.lgPGwq .sc-dntSTA{height:1.5em;width:1.5em;}/*!sc*/
|
|
319
|
+
.lgPGwq .sc-dntSTA polygon{fill:#333333;}/*!sc*/
|
|
320
|
+
.iHRgeo{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*/
|
|
321
|
+
.iHRgeo:hover{color:#32329f;background-color:#ededed;}/*!sc*/
|
|
322
|
+
.iHRgeo .sc-dntSTA{height:1.5em;width:1.5em;}/*!sc*/
|
|
323
|
+
.iHRgeo .sc-dntSTA polygon{fill:#333333;}/*!sc*/
|
|
324
|
+
data-styled.g103[id="sc-fpikKz"]{content:"lgPGwq,iHRgeo,"}/*!sc*/
|
|
325
|
+
.cxcra{display:inline-block;vertical-align:middle;width:calc(100% - 38px);overflow:hidden;text-overflow:ellipsis;}/*!sc*/
|
|
326
|
+
data-styled.g104[id="sc-gWaSiO"]{content:"cxcra,"}/*!sc*/
|
|
327
|
+
.QuyG{font-size:0.8em;margin-top:10px;text-align:center;position:fixed;width:260px;bottom:0;background:#fafafa;}/*!sc*/
|
|
328
|
+
.QuyG a,.QuyG a:visited,.QuyG 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*/
|
|
329
|
+
.QuyG img{width:15px;margin-right:5px;}/*!sc*/
|
|
330
|
+
@media screen and (max-width: 50rem){.QuyG{width:100%;}}/*!sc*/
|
|
331
|
+
data-styled.g105[id="sc-kSaXSp"]{content:"QuyG,"}/*!sc*/
|
|
332
|
+
.jjnszm{cursor:pointer;position:relative;margin-bottom:5px;}/*!sc*/
|
|
333
|
+
data-styled.g111[id="sc-eZSpzM"]{content:"jjnszm,"}/*!sc*/
|
|
334
|
+
.kZcHWP{font-family:Courier,monospace;margin-left:10px;flex:1;overflow-x:hidden;text-overflow:ellipsis;}/*!sc*/
|
|
335
|
+
data-styled.g112[id="sc-jvKoal"]{content:"kZcHWP,"}/*!sc*/
|
|
336
|
+
.iPCVMX{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*/
|
|
337
|
+
.iPCVMX ..sc-jvKoal{color:#ffffff;}/*!sc*/
|
|
338
|
+
.iPCVMX:focus{box-shadow:inset 0 2px 2px rgba(0, 0, 0, 0.45),0 2px 0 rgba(128, 128, 128, 0.25);}/*!sc*/
|
|
339
|
+
data-styled.g113[id="sc-buTqWO"]{content:"iPCVMX,"}/*!sc*/
|
|
340
|
+
.kwcmyC{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*/
|
|
341
|
+
.dynMBc{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*/
|
|
342
|
+
.dBzsUh{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*/
|
|
343
|
+
.gKcHYQ{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*/
|
|
344
|
+
data-styled.g114[id="sc-fQLpxn"]{content:"kwcmyC,dynMBc,dBzsUh,gKcHYQ,"}/*!sc*/
|
|
345
|
+
.ga-DQLq{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*/
|
|
346
|
+
data-styled.g115[id="sc-ecJghI"]{content:"ga-DQLq,"}/*!sc*/
|
|
347
|
+
.icOxsG{padding:10px;}/*!sc*/
|
|
348
|
+
data-styled.g116[id="sc-iyBeIh"]{content:"icOxsG,"}/*!sc*/
|
|
349
|
+
.okJpy{padding:5px;border:1px solid #ccc;background:#fff;word-break:break-all;color:#32329f;}/*!sc*/
|
|
350
|
+
.okJpy >span{color:#333333;}/*!sc*/
|
|
351
|
+
data-styled.g117[id="sc-xKhEK"]{content:"okJpy,"}/*!sc*/
|
|
352
|
+
.foplsk{text-transform:lowercase;margin-left:0;line-height:1.5em;}/*!sc*/
|
|
353
|
+
data-styled.g118[id="sc-eTCgfj"]{content:"foplsk,"}/*!sc*/
|
|
354
|
+
.lkmdtA{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*/
|
|
355
|
+
.lkmdtA:focus{outline:auto #1d8127;}/*!sc*/
|
|
356
|
+
.ifAHvq{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*/
|
|
357
|
+
.ifAHvq:focus{outline:auto #d41f1c;}/*!sc*/
|
|
358
|
+
.oZuve{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*/
|
|
359
|
+
.oZuve:focus{outline:auto #1d8127;}/*!sc*/
|
|
360
|
+
.oZuve::before{content:"—";font-weight:bold;width:1.5em;text-align:center;display:inline-block;vertical-align:top;}/*!sc*/
|
|
361
|
+
.oZuve:focus{outline:0;}/*!sc*/
|
|
362
|
+
data-styled.g120[id="sc-jIDBmd"]{content:"lkmdtA,ifAHvq,oZuve,"}/*!sc*/
|
|
363
|
+
.fBhAXU{vertical-align:top;}/*!sc*/
|
|
364
|
+
data-styled.g123[id="sc-eJvlPh"]{content:"fBhAXU,"}/*!sc*/
|
|
365
|
+
.kjrVcG{font-size:1.3em;padding:0.2em 0;margin:3em 0 1.1em;color:#333333;font-weight:normal;}/*!sc*/
|
|
366
|
+
data-styled.g124[id="sc-gDzyrw"]{content:"kjrVcG,"}/*!sc*/
|
|
367
|
+
.txIPi{margin-bottom:30px;}/*!sc*/
|
|
368
|
+
data-styled.g129[id="sc-bfjeOH"]{content:"txIPi,"}/*!sc*/
|
|
369
|
+
.crXcHD{user-select:none;width:20px;height:20px;align-self:center;display:flex;flex-direction:column;color:#32329f;}/*!sc*/
|
|
370
|
+
data-styled.g130[id="sc-cZnrqW"]{content:"crXcHD,"}/*!sc*/
|
|
371
|
+
.dsiHUZ{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*/
|
|
372
|
+
@media screen and (max-width: 50rem){.dsiHUZ{position:fixed;z-index:20;width:100%;background:#fafafa;display:none;}}/*!sc*/
|
|
373
|
+
@media print{.dsiHUZ{display:none;}}/*!sc*/
|
|
374
|
+
data-styled.g131[id="sc-fstJre"]{content:"dsiHUZ,"}/*!sc*/
|
|
375
|
+
.bovaLG{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*/
|
|
376
|
+
@media screen and (max-width: 50rem){.bovaLG{display:flex;}}/*!sc*/
|
|
377
|
+
.bovaLG svg{color:#0065FB;}/*!sc*/
|
|
378
|
+
@media print{.bovaLG{display:none;}}/*!sc*/
|
|
379
|
+
data-styled.g132[id="sc-jOlHRD"]{content:"bovaLG,"}/*!sc*/
|
|
380
|
+
.eHdqcJ{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*/
|
|
381
|
+
.eHdqcJ *{box-sizing:border-box;-webkit-tap-highlight-color:rgba(255, 255, 255, 0);}/*!sc*/
|
|
382
|
+
data-styled.g133[id="sc-Pgsbw"]{content:"eHdqcJ,"}/*!sc*/
|
|
383
|
+
.buanwU{z-index:1;position:relative;overflow:hidden;width:calc(100% - 260px);contain:layout;}/*!sc*/
|
|
384
|
+
@media print,screen and (max-width: 50rem){.buanwU{width:100%;}}/*!sc*/
|
|
385
|
+
data-styled.g134[id="sc-fkYqBV"]{content:"buanwU,"}/*!sc*/
|
|
386
|
+
.iZqpqg{background:#263238;position:absolute;top:0;bottom:0;right:0;width:calc((100% - 260px) * 0.4);}/*!sc*/
|
|
387
|
+
@media print,screen and (max-width: 75rem){.iZqpqg{display:none;}}/*!sc*/
|
|
388
|
+
data-styled.g135[id="sc-evkzZa"]{content:"iZqpqg,"}/*!sc*/
|
|
389
|
+
.gzMPIt{padding:5px 0;}/*!sc*/
|
|
390
|
+
data-styled.g136[id="sc-iRcyzz"]{content:"gzMPIt,"}/*!sc*/
|
|
391
|
+
.iOkeQy{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*/
|
|
392
|
+
data-styled.g137[id="sc-lhsSio"]{content:"iOkeQy,"}/*!sc*/
|
|
393
|
+
.SikXG{position:absolute;left:20px;height:1.8em;width:0.9em;}/*!sc*/
|
|
394
|
+
.SikXG path{fill:#333333;}/*!sc*/
|
|
395
|
+
data-styled.g138[id="sc-enPhjR"]{content:"SikXG,"}/*!sc*/
|
|
396
|
+
</style>
|
|
397
|
+
<link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet">
|
|
398
|
+
</head>
|
|
399
|
+
|
|
400
|
+
<body>
|
|
401
|
+
|
|
402
|
+
<div id="redoc"><div class="sc-Pgsbw eHdqcJ redoc-wrap"><div class="sc-fstJre dsiHUZ menu-content" style="top:0px;height:calc(100vh - 0px)"><div role="search" class="sc-iRcyzz gzMPIt"><svg class="sc-enPhjR SikXG 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-lhsSio iOkeQy search-input" value=""/></div><div class="sc-eknHtZ ghzOpX scrollbar-container undefined"><ul role="menu" class="sc-zOxLx gAPKXX"><li tabindex="0" depth="1" data-item-id="tag/Workflows" role="menuitem" aria-label="Workflows" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz lgPGwq -depth1"><span width="calc(100% - 38px)" title="Workflows" class="sc-gWaSiO cxcra">Workflows</span><svg class="sc-dntSTA dUlzCe" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="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-zOxLx dQnkdy"><li tabindex="0" depth="2" data-item-id="tag/Workflows/operation/createWorkflow" role="menuitem" aria-label="Create a new workflow" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="post" class="sc-jxYSNo NmQLu operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Create a new workflow</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Workflows/operation/listWorkflows" role="menuitem" aria-label="List workflows" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="get" class="sc-jxYSNo NmQLu operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">List workflows</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Workflows/operation/getWorkflow" role="menuitem" aria-label="Get workflow details" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="get" class="sc-jxYSNo NmQLu operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Get workflow details</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Workflow-Templates" role="menuitem" aria-label="Workflow Templates" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz lgPGwq -depth1"><span width="calc(100% - 38px)" title="Workflow Templates" class="sc-gWaSiO cxcra">Workflow Templates</span><svg class="sc-dntSTA dUlzCe" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="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-zOxLx dQnkdy"><li tabindex="0" depth="2" data-item-id="tag/Workflow-Templates/operation/createWorkflowTemplate" role="menuitem" aria-label="Create a new workflow template" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="post" class="sc-jxYSNo NmQLu operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Create a new workflow template</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Workflow-Templates/operation/listWorkflowTemplates" role="menuitem" aria-label="List workflow templates" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="get" class="sc-jxYSNo NmQLu operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">List workflow templates</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Workflow-Templates/operation/getWorkflowTemplate" role="menuitem" aria-label="Get workflow template details" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="get" class="sc-jxYSNo NmQLu operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Get workflow template details</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Workflow-Templates/operation/updateWorkflowTemplate" role="menuitem" aria-label="Update a workflow template" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="put" class="sc-jxYSNo NmQLu operation-type put">put</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Update a workflow template</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Workflow-Templates/operation/deleteWorkflowTemplate" role="menuitem" aria-label="Delete a workflow template" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="delete" class="sc-jxYSNo NmQLu operation-type delete">del</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Delete a workflow template</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Users" role="menuitem" aria-label="Users" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz lgPGwq -depth1"><span width="calc(100% - 38px)" title="Users" class="sc-gWaSiO cxcra">Users</span><svg class="sc-dntSTA dUlzCe" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="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-zOxLx dQnkdy"><li tabindex="0" depth="2" data-item-id="tag/Users/operation/createUser" role="menuitem" aria-label="Create a new user" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="post" class="sc-jxYSNo NmQLu operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Create a new user</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Users/operation/listUsers" role="menuitem" aria-label="List users" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="get" class="sc-jxYSNo NmQLu operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">List users</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Users/operation/getUser" role="menuitem" aria-label="Get user details" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="get" class="sc-jxYSNo NmQLu operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Get user details</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Users/operation/listGroupEntities" role="menuitem" aria-label="List entities in a group" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="get" class="sc-jxYSNo NmQLu operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">List entities in a group</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Users/operation/addGroupEntities" role="menuitem" aria-label="Add group entities" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="post" class="sc-jxYSNo NmQLu operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Add group entities</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Users/operation/removeGroupEntities" role="menuitem" aria-label="Remove group entities" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="delete" class="sc-jxYSNo NmQLu operation-type delete">del</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Remove group entities</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Groups" role="menuitem" aria-label="Groups" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz lgPGwq -depth1"><span width="calc(100% - 38px)" title="Groups" class="sc-gWaSiO cxcra">Groups</span><svg class="sc-dntSTA dUlzCe" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="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-zOxLx dQnkdy"><li tabindex="0" depth="2" data-item-id="tag/Groups/operation/createGroup" role="menuitem" aria-label="Create a new approver group" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="post" class="sc-jxYSNo NmQLu operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Create a new approver group</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Groups/operation/listGroups" role="menuitem" aria-label="List groups" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="get" class="sc-jxYSNo NmQLu operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">List groups</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Groups/operation/getGroup" role="menuitem" aria-label="Get group details" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="get" class="sc-jxYSNo NmQLu operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Get group details</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Groups/operation/listGroupEntities" role="menuitem" aria-label="List entities in a group" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="get" class="sc-jxYSNo NmQLu operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">List entities in a group</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Groups/operation/addGroupEntities" role="menuitem" aria-label="Add group entities" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="post" class="sc-jxYSNo NmQLu operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Add group entities</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Groups/operation/removeGroupEntities" role="menuitem" aria-label="Remove group entities" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="delete" class="sc-jxYSNo NmQLu operation-type delete">del</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Remove group entities</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Workflow-Actions" role="menuitem" aria-label="Workflow Actions" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz lgPGwq -depth1"><span width="calc(100% - 38px)" title="Workflow Actions" class="sc-gWaSiO cxcra">Workflow Actions</span><svg class="sc-dntSTA dUlzCe" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="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-zOxLx dQnkdy"><li tabindex="0" depth="2" data-item-id="tag/Workflow-Actions/operation/voteOnWorkflow" role="menuitem" aria-label="Vote on a workflow" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="post" class="sc-jxYSNo NmQLu operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Vote on a workflow</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Workflow-Actions/operation/canVoteOnWorkflow" role="menuitem" aria-label="Check if the current entity can vote on a workflow" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="get" class="sc-jxYSNo NmQLu operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Check if the current entity can vote on a workflow</span></label></li></ul></li></ul><div class="sc-kSaXSp QuyG"><a target="_blank" rel="noopener noreferrer" href="https://redocly.com/redoc/">API docs by Redocly</a></div></div></div><div class="sc-jOlHRD bovaLG"><div class="sc-cZnrqW crXcHD"><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="
|
|
403
|
+
m -673.67664,1221.6502 -231.2455,-231.24803 55.6165,
|
|
404
|
+
-55.627 c 30.5891,-30.59485 56.1806,-55.627 56.8701,-55.627 0.6894,
|
|
405
|
+
0 79.8637,78.60862 175.9427,174.68583 l 174.6892,174.6858 174.6892,
|
|
406
|
+
-174.6858 c 96.079,-96.07721 175.253196,-174.68583 175.942696,
|
|
407
|
+
-174.68583 0.6895,0 26.281,25.03215 56.8701,
|
|
408
|
+
55.627 l 55.6165,55.627 -231.245496,231.24803 c -127.185,127.1864
|
|
409
|
+
-231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688,
|
|
410
|
+
-104.0616 -231.873,-231.248 z
|
|
411
|
+
" 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="
|
|
412
|
+
m -673.67664,1221.6502 -231.2455,-231.24803 55.6165,
|
|
413
|
+
-55.627 c 30.5891,-30.59485 56.1806,-55.627 56.8701,-55.627 0.6894,
|
|
414
|
+
0 79.8637,78.60862 175.9427,174.68583 l 174.6892,174.6858 174.6892,
|
|
415
|
+
-174.6858 c 96.079,-96.07721 175.253196,-174.68583 175.942696,
|
|
416
|
+
-174.68583 0.6895,0 26.281,25.03215 56.8701,
|
|
417
|
+
55.627 l 55.6165,55.627 -231.245496,231.24803 c -127.185,127.1864
|
|
418
|
+
-231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688,
|
|
419
|
+
-104.0616 -231.873,-231.248 z
|
|
420
|
+
" fill="currentColor"></path></g></svg></div></div><div class="sc-fkYqBV buanwU api-content"><div class="sc-dTvVRJ bPmFpz"><div class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU api-info"><h1 class="sc-hwkwBN sc-jCWzJg wYHiz hPcPCj">Workflow Approval System API<!-- --> <span>(<!-- -->0.0.6<!-- -->)</span></h1><p>Download OpenAPI specification<!-- -->:</p><div class="sc-eVqvcJ sc-fszimp kIppRw kbZred"></div><div data-role="redoc-summary" html="" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"></div><div data-role="redoc-description" html="<p>API for a SaaS platform that allows customers to manage approvals for generic workflows, users, and groups.</p>
|
|
421
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>API for a SaaS platform that allows customers to manage approvals for generic workflows, users, and groups.</p>
|
|
422
|
+
</div></div></div></div><div id="tag/Workflows" data-section-id="tag/Workflows" class="sc-dTvVRJ bPmFpz"><div class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Workflows" aria-label="tag/Workflows"></a>Workflows</h2></div></div><div class="sc-ggWZvA dCzIPc"><div class="sc-eVqvcJ sc-fszimp kIppRw kbZred redoc-markdown " html="<p>Workflow management and approval</p>
|
|
423
|
+
"><p>Workflow management and approval</p>
|
|
424
|
+
</div></div></div><div id="tag/Workflows/operation/createWorkflow" data-section-id="tag/Workflows/operation/createWorkflow" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/createWorkflow" id="operation/createWorkflow" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Workflows/operation/createWorkflow" aria-label="tag/Workflows/operation/createWorkflow"></a>Create a new workflow<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Creates a new workflow with approvers and rules</p>
|
|
425
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Creates a new workflow with approvers and rules</p>
|
|
426
|
+
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><h5 class="sc-eqYatC czjApA">Request Body schema: <span class="sc-dNFkOE cFlAeY">application/json</span><div class="sc-bEjUoa sc-iIvHqT sc-eTCgfj lhyyLL crXmiY foplsk">required</div></h5><div html="" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"></div><table class="sc-eqNDNG icJLQx"><tbody><tr class=""><td kind="field" title="name" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">name</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="<p>User-friendly name for the workflow</p>
|
|
427
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>User-friendly name for the workflow</p>
|
|
428
|
+
</div></div></div></td></tr><tr class=""><td kind="field" title="description" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">description</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="<p>Detailed description of the workflow</p>
|
|
429
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Detailed description of the workflow</p>
|
|
430
|
+
</div></div></div></td></tr><tr class=""><td kind="field" title="metadata" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">metadata</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">object</span></div> <div><div html="<p>Additional custom metadata for the workflow</p>
|
|
431
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Additional custom metadata for the workflow</p>
|
|
432
|
+
</div></div></div></td></tr><tr class="last "><td kind="field" title="workflowTemplateId" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">workflowTemplateId</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq"> <!-- --><<!-- -->uuid<!-- -->><!-- --> </span></div> <div><div html="<p>The unique identifier of the workflow template to use as parent</p>
|
|
433
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The unique identifier of the workflow template to use as parent</p>
|
|
434
|
+
</div></div></div></td></tr></tbody></table><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">201<!-- --> </strong><div html="<p>Workflow created successfully</p>
|
|
435
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Workflow created successfully</p>
|
|
436
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">400<!-- --> </strong><div html="<p>Invalid request</p>
|
|
437
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Invalid request</p>
|
|
438
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Authentication required</p>
|
|
439
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
440
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="post" class="sc-fQLpxn kwcmyC http-verb post">post</span><span class="sc-jvKoal kZcHWP">/workflows</span><svg class="sc-dntSTA iuNpUs" 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-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/workflows</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Request samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«Riioq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«Riioq»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«Riioq»0" aria-labelledby="tab«Riioq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><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">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"workflowTemplateId"</span>: <span class="token string">"53e62d87-459b-4f1f-ae45-ffe2549e140f"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«Rjioq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«Rjioq»0" tabindex="0" data-rttab="true">201</li><li class="tab-error" role="tab" id="tab«Rjioq»1" aria-selected="false" aria-disabled="false" aria-controls="panel«Rjioq»1" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab«Rjioq»2" aria-selected="false" aria-disabled="false" aria-controls="panel«Rjioq»2" data-rttab="true">401</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«Rjioq»0" aria-labelledby="tab«Rjioq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><span class="token punctuation">{ }</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«Rjioq»1" aria-labelledby="tab«Rjioq»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«Rjioq»2" aria-labelledby="tab«Rjioq»2"></div></div></div></div></div></div><div id="tag/Workflows/operation/listWorkflows" data-section-id="tag/Workflows/operation/listWorkflows" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/listWorkflows" id="operation/listWorkflows" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Workflows/operation/listWorkflows" aria-label="tag/Workflows/operation/listWorkflows"></a>List workflows<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Returns a list of workflows with optional filtering</p>
|
|
441
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Returns a list of workflows with optional filtering</p>
|
|
442
|
+
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">query<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class=""><td kind="field" title="page" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">page</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">integer</span></div><div><span class="sc-bEjUoa lhyyLL"> <!-- -->Default:<!-- --> </span> <span class="sc-bEjUoa sc-dTWiOz lhyyLL kMQdIk">1</span></div> <div><div html="<p>Page number for pagination</p>
|
|
443
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Page number for pagination</p>
|
|
444
|
+
</div></div></div></td></tr><tr class=""><td kind="field" title="limit" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">limit</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">integer</span></div><div><span class="sc-bEjUoa lhyyLL"> <!-- -->Default:<!-- --> </span> <span class="sc-bEjUoa sc-dTWiOz lhyyLL kMQdIk">20</span></div> <div><div html="<p>Number of results per page</p>
|
|
445
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Number of results per page</p>
|
|
446
|
+
</div></div></div></td></tr><tr class="last "><td kind="field" title="include" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">include</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP">Array of </span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">strings</span></div><div><span class="sc-bEjUoa lhyyLL">Items<!-- --> <!-- -->Value<!-- -->:</span> <span class="sc-bEjUoa sc-dTWiOz lhyyLL kMQdIk">"workflow-template"</span> </div> <div><div html="<p>Comma-separated list of related objects to include in the response</p>
|
|
447
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Comma-separated list of related objects to include in the response</p>
|
|
448
|
+
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">200<!-- --> </strong><div html="<p>List of workflows</p>
|
|
449
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>List of workflows</p>
|
|
450
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Authentication required</p>
|
|
451
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
452
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="get" class="sc-fQLpxn dynMBc http-verb get">get</span><span class="sc-jvKoal kZcHWP">/workflows</span><svg class="sc-dntSTA iuNpUs" 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-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/workflows</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«Rjj8q»0" aria-selected="true" aria-disabled="false" aria-controls="panel«Rjj8q»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«Rjj8q»1" aria-selected="false" aria-disabled="false" aria-controls="panel«Rjj8q»1" data-rttab="true">401</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«Rjj8q»0" aria-labelledby="tab«Rjj8q»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><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">"data"</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 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">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"status"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"workflowTemplateId"</span>: <span class="token string">"53e62d87-459b-4f1f-ae45-ffe2549e140f"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ref"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"workflowTemplate"</span>: <button class="collapser" aria-label="expand"></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">"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">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"approvalRule"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"AND"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"rules"</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 keyword">null</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">"metadata"</span>: <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="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">"type"</span>: <span class="token string">"EMAIL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"recipients"</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">"user@example.com"</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 collapsed"><span class="property token string">"defaultExpiresInHours"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"updatedAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</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">"createdAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"updatedAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"expiresAt"</span>: <span class="token string">"2025-04-15T12:05:00Z"</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">"pagination"</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">"total"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"page"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"limit"</span>: <span class="token number">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 class="react-tabs__tab-panel" role="tabpanel" id="panel«Rjj8q»1" aria-labelledby="tab«Rjj8q»1"></div></div></div></div></div></div><div id="tag/Workflows/operation/getWorkflow" data-section-id="tag/Workflows/operation/getWorkflow" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/getWorkflow" id="operation/getWorkflow" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Workflows/operation/getWorkflow" aria-label="tag/Workflows/operation/getWorkflow"></a>Get workflow details<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Returns the details of a specific workflow</p>
|
|
453
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Returns the details of a specific workflow</p>
|
|
454
|
+
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">path<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="workflowId" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">workflowId</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="<p>The unique identifier of the workflow</p>
|
|
455
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The unique identifier of the workflow</p>
|
|
456
|
+
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-eqYatC czjApA">query<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="include" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">include</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP">Array of </span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">strings</span></div><div><span class="sc-bEjUoa lhyyLL">Items<!-- --> <!-- -->Value<!-- -->:</span> <span class="sc-bEjUoa sc-dTWiOz lhyyLL kMQdIk">"workflow-template"</span> </div> <div><div html="<p>Comma-separated list of related objects to include in the response</p>
|
|
457
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Comma-separated list of related objects to include in the response</p>
|
|
458
|
+
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">200<!-- --> </strong><div html="<p>Workflow details</p>
|
|
459
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Workflow details</p>
|
|
460
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Authentication required</p>
|
|
461
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
462
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">404<!-- --> </strong><div html="<p>Resource not found</p>
|
|
463
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Resource not found</p>
|
|
464
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="get" class="sc-fQLpxn dynMBc http-verb get">get</span><span class="sc-jvKoal kZcHWP">/workflows/{workflowId}</span><svg class="sc-dntSTA iuNpUs" 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-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/workflows/{workflowId}</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«Rjjoq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«Rjjoq»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«Rjjoq»1" aria-selected="false" aria-disabled="false" aria-controls="panel«Rjjoq»1" data-rttab="true">401</li><li class="tab-error" role="tab" id="tab«Rjjoq»2" aria-selected="false" aria-disabled="false" aria-controls="panel«Rjjoq»2" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«Rjjoq»0" aria-labelledby="tab«Rjjoq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><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 string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"workflowTemplateId"</span>: <span class="token string">"53e62d87-459b-4f1f-ae45-ffe2549e140f"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ref"</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">"workflowTemplate"</span>: <button class="collapser" aria-label="expand"></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">"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">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"approvalRule"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"AND"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"rules"</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 keyword">null</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">"metadata"</span>: <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="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">"type"</span>: <span class="token string">"EMAIL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"recipients"</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">"user@example.com"</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 collapsed"><span class="property token string">"defaultExpiresInHours"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"updatedAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</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">"createdAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"updatedAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expiresAt"</span>: <span class="token string">"2025-04-15T12:05:00Z"</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="panel«Rjjoq»1" aria-labelledby="tab«Rjjoq»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«Rjjoq»2" aria-labelledby="tab«Rjjoq»2"></div></div></div></div></div></div><div id="tag/Workflow-Templates" data-section-id="tag/Workflow-Templates" class="sc-dTvVRJ bPmFpz"><div class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Workflow-Templates" aria-label="tag/Workflow-Templates"></a>Workflow Templates</h2></div></div><div class="sc-ggWZvA dCzIPc"><div class="sc-eVqvcJ sc-fszimp kIppRw kbZred redoc-markdown " html="<p>Workflow template management</p>
|
|
465
|
+
"><p>Workflow template management</p>
|
|
466
|
+
</div></div></div><div id="tag/Workflow-Templates/operation/createWorkflowTemplate" data-section-id="tag/Workflow-Templates/operation/createWorkflowTemplate" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/createWorkflowTemplate" id="operation/createWorkflowTemplate" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Workflow-Templates/operation/createWorkflowTemplate" aria-label="tag/Workflow-Templates/operation/createWorkflowTemplate"></a>Create a new workflow template<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Creates a new workflow template with approval rules, actions, and default expiry settings</p>
|
|
467
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Creates a new workflow template with approval rules, actions, and default expiry settings</p>
|
|
468
|
+
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><h5 class="sc-eqYatC czjApA">Request Body schema: <span class="sc-dNFkOE cFlAeY">application/json</span><div class="sc-bEjUoa sc-iIvHqT sc-eTCgfj lhyyLL crXmiY foplsk">required</div></h5><div html="" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"></div><table class="sc-eqNDNG icJLQx"><tbody><tr class=""><td kind="field" title="name" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">name</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="<p>User-friendly name for the workflow template</p>
|
|
469
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>User-friendly name for the workflow template</p>
|
|
470
|
+
</div></div></div></td></tr><tr class=""><td kind="field" title="description" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">description</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="<p>Detailed description of the workflow template</p>
|
|
471
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Detailed description of the workflow template</p>
|
|
472
|
+
</div></div></div></td></tr><tr class=""><td kind="field" title="metadata" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">metadata</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">object</span></div> <div><div html="<p>Additional custom metadata for the workflow template</p>
|
|
473
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Additional custom metadata for the workflow template</p>
|
|
474
|
+
</div></div></div></td></tr><tr class=""><td kind="field" title="approvalRule" class="sc-kCuUfV sc-fbQrwq sc-itBLYH gdmNWp dFOJWJ kdPQHX"><span class="sc-hwddKA cteAyA"></span><button aria-label="expand approvalRule"><span class="property-name">approvalRule</span><svg class="sc-dntSTA dOPmTa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="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 class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">any</span><span class="sc-bEjUoa sc-hdBJTi lhyyLL nwQTz"> (<!-- -->ApprovalRule<!-- -->) </span></div> <div><div html="<p>Configuration of approval rules. Can be a boolean operator (AND/OR) combining nested rules, or a specific requirement (minimum count from a group).</p>
|
|
475
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Configuration of approval rules. Can be a boolean operator (AND/OR) combining nested rules, or a specific requirement (minimum count from a group).</p>
|
|
476
|
+
</div></div></div></td></tr><tr class=""><td kind="field" title="actions" class="sc-kCuUfV sc-fbQrwq sc-itBLYH gdmNWp dFOJWJ kdPQHX"><span class="sc-hwddKA cteAyA"></span><button aria-label="expand actions"><span class="property-name">actions</span><svg class="sc-dntSTA dOPmTa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="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-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP">Array of </span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">any</span><span class="sc-bEjUoa sc-hdBJTi lhyyLL nwQTz"> (<!-- -->WorkflowAction<!-- -->) </span></div> <div><div html="<p>Actions to be executed when workflow is approved</p>
|
|
477
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Actions to be executed when workflow is approved</p>
|
|
478
|
+
</div></div></div></td></tr><tr class="last "><td kind="field" title="defaultExpiresInHours" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">defaultExpiresInHours</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">integer</span><span> <span class="sc-bEjUoa sc-goiVcJ lhyyLL bDfgbe"> <!-- -->[ 1 .. 8760 ]<!-- --> </span></span></div> <div><div html="<p>Default expiry time for workflows created from this template (in hours, max 1 year)</p>
|
|
479
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Default expiry time for workflows created from this template (in hours, max 1 year)</p>
|
|
480
|
+
</div></div></div></td></tr></tbody></table><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">201<!-- --> </strong><div html="<p>Workflow template created successfully</p>
|
|
481
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Workflow template created successfully</p>
|
|
482
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">400<!-- --> </strong><div html="<p>Invalid request</p>
|
|
483
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Invalid request</p>
|
|
484
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Authentication required</p>
|
|
485
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
486
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="post" class="sc-fQLpxn kwcmyC http-verb post">post</span><span class="sc-jvKoal kZcHWP">/workflow-templates</span><svg class="sc-dntSTA iuNpUs" 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-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/workflow-templates</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Request samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«R154pa»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R154pa»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R154pa»0" aria-labelledby="tab«R154pa»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><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">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"approvalRule"</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">"type"</span>: <span class="token string">"AND"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"rules"</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 keyword">null</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">"actions"</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">"type"</span>: <span class="token string">"EMAIL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"recipients"</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">"user@example.com"</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">"defaultExpiresInHours"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R174pa»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R174pa»0" tabindex="0" data-rttab="true">201</li><li class="tab-error" role="tab" id="tab«R174pa»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R174pa»1" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab«R174pa»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R174pa»2" data-rttab="true">401</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R174pa»0" aria-labelledby="tab«R174pa»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><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 string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"approvalRule"</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">"type"</span>: <span class="token string">"AND"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"rules"</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 keyword">null</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">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><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="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">"type"</span>: <span class="token string">"EMAIL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"recipients"</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">"user@example.com"</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">"defaultExpiresInHours"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"updatedAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</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="panel«R174pa»1" aria-labelledby="tab«R174pa»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R174pa»2" aria-labelledby="tab«R174pa»2"></div></div></div></div></div></div><div id="tag/Workflow-Templates/operation/listWorkflowTemplates" data-section-id="tag/Workflow-Templates/operation/listWorkflowTemplates" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/listWorkflowTemplates" id="operation/listWorkflowTemplates" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Workflow-Templates/operation/listWorkflowTemplates" aria-label="tag/Workflow-Templates/operation/listWorkflowTemplates"></a>List workflow templates<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Returns a list of workflow templates with optional filtering</p>
|
|
487
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Returns a list of workflow templates with optional filtering</p>
|
|
488
|
+
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">query<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class=""><td kind="field" title="page" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">page</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">integer</span></div><div><span class="sc-bEjUoa lhyyLL"> <!-- -->Default:<!-- --> </span> <span class="sc-bEjUoa sc-dTWiOz lhyyLL kMQdIk">1</span></div> <div><div html="<p>Page number for pagination</p>
|
|
489
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Page number for pagination</p>
|
|
490
|
+
</div></div></div></td></tr><tr class="last "><td kind="field" title="limit" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">limit</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">integer</span></div><div><span class="sc-bEjUoa lhyyLL"> <!-- -->Default:<!-- --> </span> <span class="sc-bEjUoa sc-dTWiOz lhyyLL kMQdIk">20</span></div> <div><div html="<p>Number of results per page</p>
|
|
491
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Number of results per page</p>
|
|
492
|
+
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">200<!-- --> </strong><div html="<p>List of workflow templates</p>
|
|
493
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>List of workflow templates</p>
|
|
494
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Authentication required</p>
|
|
495
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
496
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="get" class="sc-fQLpxn dynMBc http-verb get">get</span><span class="sc-jvKoal kZcHWP">/workflow-templates</span><svg class="sc-dntSTA iuNpUs" 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-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/workflow-templates</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R1759a»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R1759a»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«R1759a»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R1759a»1" data-rttab="true">401</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R1759a»0" aria-labelledby="tab«R1759a»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><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">"data"</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 string">"a1b2c3d4-e5f6-7890-1234-567890abcdef"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"New Workflow Template"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"This is a new workflow template"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token string">"2025-04-15T12:05:00Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"updatedAt"</span>: <span class="token string">"2025-04-15T12:05:00Z"</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">"pagination"</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">"total"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"page"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"limit"</span>: <span class="token number">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 class="react-tabs__tab-panel" role="tabpanel" id="panel«R1759a»1" aria-labelledby="tab«R1759a»1"></div></div></div></div></div></div><div id="tag/Workflow-Templates/operation/getWorkflowTemplate" data-section-id="tag/Workflow-Templates/operation/getWorkflowTemplate" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/getWorkflowTemplate" id="operation/getWorkflowTemplate" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Workflow-Templates/operation/getWorkflowTemplate" aria-label="tag/Workflow-Templates/operation/getWorkflowTemplate"></a>Get workflow template details<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Returns the details of a specific workflow template</p>
|
|
497
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Returns the details of a specific workflow template</p>
|
|
498
|
+
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">path<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="templateId" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">templateId</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="<p>The unique identifier of the workflow template</p>
|
|
499
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The unique identifier of the workflow template</p>
|
|
500
|
+
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">200<!-- --> </strong><div html="<p>Workflow template details</p>
|
|
501
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Workflow template details</p>
|
|
502
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Authentication required</p>
|
|
503
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
504
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">404<!-- --> </strong><div html="<p>Resource not found</p>
|
|
505
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Resource not found</p>
|
|
506
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="get" class="sc-fQLpxn dynMBc http-verb get">get</span><span class="sc-jvKoal kZcHWP">/workflow-templates/{templateId}</span><svg class="sc-dntSTA iuNpUs" 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-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/workflow-templates/{templateId}</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R175pa»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R175pa»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«R175pa»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R175pa»1" data-rttab="true">401</li><li class="tab-error" role="tab" id="tab«R175pa»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R175pa»2" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R175pa»0" aria-labelledby="tab«R175pa»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><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 string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"approvalRule"</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">"type"</span>: <span class="token string">"AND"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"rules"</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 keyword">null</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">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><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="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">"type"</span>: <span class="token string">"EMAIL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"recipients"</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">"user@example.com"</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">"defaultExpiresInHours"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"updatedAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</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="panel«R175pa»1" aria-labelledby="tab«R175pa»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R175pa»2" aria-labelledby="tab«R175pa»2"></div></div></div></div></div></div><div id="tag/Workflow-Templates/operation/updateWorkflowTemplate" data-section-id="tag/Workflow-Templates/operation/updateWorkflowTemplate" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/updateWorkflowTemplate" id="operation/updateWorkflowTemplate" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Workflow-Templates/operation/updateWorkflowTemplate" aria-label="tag/Workflow-Templates/operation/updateWorkflowTemplate"></a>Update a workflow template<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Updates an existing workflow template</p>
|
|
507
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Updates an existing workflow template</p>
|
|
508
|
+
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">path<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="templateId" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">templateId</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="<p>The unique identifier of the workflow template</p>
|
|
509
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The unique identifier of the workflow template</p>
|
|
510
|
+
</div></div></div></td></tr></tbody></table></div><h5 class="sc-eqYatC czjApA">Request Body schema: <span class="sc-dNFkOE cFlAeY">application/json</span><div class="sc-bEjUoa sc-iIvHqT sc-eTCgfj lhyyLL crXmiY foplsk">required</div></h5><div html="" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"></div><table class="sc-eqNDNG icJLQx"><tbody><tr class=""><td kind="field" title="name" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">name</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="<p>User-friendly name for the workflow template</p>
|
|
511
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>User-friendly name for the workflow template</p>
|
|
512
|
+
</div></div></div></td></tr><tr class=""><td kind="field" title="description" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">description</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="<p>Detailed description of the workflow template</p>
|
|
513
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Detailed description of the workflow template</p>
|
|
514
|
+
</div></div></div></td></tr><tr class=""><td kind="field" title="metadata" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">metadata</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">object</span></div> <div><div html="<p>Additional custom metadata for the workflow template</p>
|
|
515
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Additional custom metadata for the workflow template</p>
|
|
516
|
+
</div></div></div></td></tr><tr class=""><td kind="field" title="approvalRule" class="sc-kCuUfV sc-fbQrwq sc-itBLYH gdmNWp dFOJWJ kdPQHX"><span class="sc-hwddKA cteAyA"></span><button aria-label="expand approvalRule"><span class="property-name">approvalRule</span><svg class="sc-dntSTA dOPmTa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="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-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">any</span><span class="sc-bEjUoa sc-hdBJTi lhyyLL nwQTz"> (<!-- -->ApprovalRule<!-- -->) </span></div> <div><div html="<p>Configuration of approval rules. Can be a boolean operator (AND/OR) combining nested rules, or a specific requirement (minimum count from a group).</p>
|
|
517
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Configuration of approval rules. Can be a boolean operator (AND/OR) combining nested rules, or a specific requirement (minimum count from a group).</p>
|
|
518
|
+
</div></div></div></td></tr><tr class=""><td kind="field" title="actions" class="sc-kCuUfV sc-fbQrwq sc-itBLYH gdmNWp dFOJWJ kdPQHX"><span class="sc-hwddKA cteAyA"></span><button aria-label="expand actions"><span class="property-name">actions</span><svg class="sc-dntSTA dOPmTa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="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-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP">Array of </span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">any</span><span class="sc-bEjUoa sc-hdBJTi lhyyLL nwQTz"> (<!-- -->WorkflowAction<!-- -->) </span></div> <div><div html="<p>Actions to be executed when workflow is approved</p>
|
|
519
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Actions to be executed when workflow is approved</p>
|
|
520
|
+
</div></div></div></td></tr><tr class="last "><td kind="field" title="defaultExpiresInHours" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">defaultExpiresInHours</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">integer</span><span> <span class="sc-bEjUoa sc-goiVcJ lhyyLL bDfgbe"> <!-- -->[ 1 .. 8760 ]<!-- --> </span></span></div> <div><div html="<p>Default expiry time for workflows created from this template (in hours, max 1 year)</p>
|
|
521
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Default expiry time for workflows created from this template (in hours, max 1 year)</p>
|
|
522
|
+
</div></div></div></td></tr></tbody></table><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">200<!-- --> </strong><div html="<p>Workflow template updated successfully</p>
|
|
523
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Workflow template updated successfully</p>
|
|
524
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">400<!-- --> </strong><div html="<p>Invalid request</p>
|
|
525
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Invalid request</p>
|
|
526
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Authentication required</p>
|
|
527
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
528
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">404<!-- --> </strong><div html="<p>Resource not found</p>
|
|
529
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Resource not found</p>
|
|
530
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="put" class="sc-fQLpxn dBzsUh http-verb put">put</span><span class="sc-jvKoal kZcHWP">/workflow-templates/{templateId}</span><svg class="sc-dntSTA iuNpUs" 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-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/workflow-templates/{templateId}</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Request samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«R1569a»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R1569a»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R1569a»0" aria-labelledby="tab«R1569a»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><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">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"approvalRule"</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">"type"</span>: <span class="token string">"AND"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"rules"</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 keyword">null</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">"actions"</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">"type"</span>: <span class="token string">"EMAIL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"recipients"</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">"user@example.com"</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">"defaultExpiresInHours"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R1769a»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R1769a»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«R1769a»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R1769a»1" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab«R1769a»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R1769a»2" data-rttab="true">401</li><li class="tab-error" role="tab" id="tab«R1769a»3" aria-selected="false" aria-disabled="false" aria-controls="panel«R1769a»3" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R1769a»0" aria-labelledby="tab«R1769a»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><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 string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"approvalRule"</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">"type"</span>: <span class="token string">"AND"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"rules"</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 keyword">null</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">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><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="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">"type"</span>: <span class="token string">"EMAIL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"recipients"</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">"user@example.com"</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">"defaultExpiresInHours"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"updatedAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</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="panel«R1769a»1" aria-labelledby="tab«R1769a»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R1769a»2" aria-labelledby="tab«R1769a»2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R1769a»3" aria-labelledby="tab«R1769a»3"></div></div></div></div></div></div><div id="tag/Workflow-Templates/operation/deleteWorkflowTemplate" data-section-id="tag/Workflow-Templates/operation/deleteWorkflowTemplate" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/deleteWorkflowTemplate" id="operation/deleteWorkflowTemplate" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Workflow-Templates/operation/deleteWorkflowTemplate" aria-label="tag/Workflow-Templates/operation/deleteWorkflowTemplate"></a>Delete a workflow template<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Deletes a workflow template</p>
|
|
531
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Deletes a workflow template</p>
|
|
532
|
+
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">path<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="templateId" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">templateId</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="<p>The unique identifier of the workflow template</p>
|
|
533
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The unique identifier of the workflow template</p>
|
|
534
|
+
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd oZuve" disabled=""><strong class="sc-eJvlPh fBhAXU">204<!-- --> </strong><div html="<p>Workflow template deleted successfully</p>
|
|
535
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Workflow template deleted successfully</p>
|
|
536
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Authentication required</p>
|
|
537
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
538
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">404<!-- --> </strong><div html="<p>Resource not found</p>
|
|
539
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Resource not found</p>
|
|
540
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="delete" class="sc-fQLpxn gKcHYQ http-verb delete">delete</span><span class="sc-jvKoal kZcHWP">/workflow-templates/{templateId}</span><svg class="sc-dntSTA iuNpUs" 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-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/workflow-templates/{templateId}</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="tab«R176pa»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R176pa»0" tabindex="0" data-rttab="true">401</li><li class="tab-error" role="tab" id="tab«R176pa»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R176pa»1" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R176pa»0" aria-labelledby="tab«R176pa»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><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">"code"</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">"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"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"field"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"message"</span>: <span class="token string">"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="panel«R176pa»1" aria-labelledby="tab«R176pa»1"></div></div></div></div></div></div><div id="tag/Users" data-section-id="tag/Users" class="sc-dTvVRJ bPmFpz"><div class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Users" aria-label="tag/Users"></a>Users</h2></div></div><div class="sc-ggWZvA dCzIPc"><div class="sc-eVqvcJ sc-fszimp kIppRw kbZred redoc-markdown " html="<p>User management</p>
|
|
541
|
+
"><p>User management</p>
|
|
542
|
+
</div></div></div><div id="tag/Users/operation/createUser" data-section-id="tag/Users/operation/createUser" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/createUser" id="operation/createUser" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Users/operation/createUser" aria-label="tag/Users/operation/createUser"></a>Create a new user<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Creates a new user in the system.</p>
|
|
543
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Creates a new user in the system.</p>
|
|
544
|
+
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><h5 class="sc-eqYatC czjApA">Request Body schema: <span class="sc-dNFkOE cFlAeY">application/json</span><div class="sc-bEjUoa sc-iIvHqT sc-eTCgfj lhyyLL crXmiY foplsk">required</div></h5><div html="" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"></div><table class="sc-eqNDNG icJLQx"><tbody><tr class=""><td kind="field" title="displayName" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">displayName</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="<p>User&#39;s display name.</p>
|
|
545
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>User's display name.</p>
|
|
546
|
+
</div></div></div></td></tr><tr class=""><td kind="field" title="email" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">email</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq"> <!-- --><<!-- -->email<!-- -->><!-- --> </span></div> <div><div html="<p>User&#39;s email address (must be unique).</p>
|
|
547
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>User's email address (must be unique).</p>
|
|
548
|
+
</div></div></div></td></tr><tr class="last "><td kind="field" title="orgRole" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">orgRole</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="<p>Role assigned to the user within the group.</p>
|
|
549
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Role assigned to the user within the group.</p>
|
|
550
|
+
</div></div></div></td></tr></tbody></table><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">201<!-- --> </strong><div html="<p>User created successfully</p>
|
|
551
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>User created successfully</p>
|
|
552
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">400<!-- --> </strong><div html="<p>Invalid request</p>
|
|
553
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Invalid request</p>
|
|
554
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Authentication required</p>
|
|
555
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
556
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">409<!-- --> </strong><div html="<p>User with this email already exists</p>
|
|
557
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>User with this email already exists</p>
|
|
558
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="post" class="sc-fQLpxn kwcmyC http-verb post">post</span><span class="sc-jvKoal kZcHWP">/users</span><svg class="sc-dntSTA iuNpUs" 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-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/users</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Request samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«R154pq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R154pq»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R154pq»0" aria-labelledby="tab«R154pq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><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">"displayName"</span>: <span class="token string">"Alex Chen"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"email"</span>: <span class="token string">"alex.chen@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"orgRole"</span>: <span class="token string">"member"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R174pq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R174pq»0" tabindex="0" data-rttab="true">201</li><li class="tab-error" role="tab" id="tab«R174pq»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R174pq»1" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab«R174pq»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R174pq»2" data-rttab="true">401</li><li class="tab-error" role="tab" id="tab«R174pq»3" aria-selected="false" aria-disabled="false" aria-controls="panel«R174pq»3" data-rttab="true">409</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R174pq»0" aria-labelledby="tab«R174pq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><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 string">"a1b2c3d4-e5f6-7890-1234-567890abcdef"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"displayName"</span>: <span class="token string">"Alex Chen"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"email"</span>: <span class="token string">"alex.chen@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token string">"2025-04-15T12:05:00Z"</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="panel«R174pq»1" aria-labelledby="tab«R174pq»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R174pq»2" aria-labelledby="tab«R174pq»2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R174pq»3" aria-labelledby="tab«R174pq»3"></div></div></div></div></div></div><div id="tag/Users/operation/listUsers" data-section-id="tag/Users/operation/listUsers" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/listUsers" id="operation/listUsers" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Users/operation/listUsers" aria-label="tag/Users/operation/listUsers"></a>List users<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Returns a list of users</p>
|
|
559
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Returns a list of users</p>
|
|
560
|
+
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">query<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class=""><td kind="field" title="search" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">search</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="<p>Fuzzy search term for user display name or email.</p>
|
|
561
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Fuzzy search term for user display name or email.</p>
|
|
562
|
+
</div></div></div></td></tr><tr class=""><td kind="field" title="page" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">page</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">integer</span></div><div><span class="sc-bEjUoa lhyyLL"> <!-- -->Default:<!-- --> </span> <span class="sc-bEjUoa sc-dTWiOz lhyyLL kMQdIk">1</span></div> <div><div html="<p>Page number for pagination</p>
|
|
563
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Page number for pagination</p>
|
|
564
|
+
</div></div></div></td></tr><tr class="last "><td kind="field" title="limit" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">limit</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">integer</span></div><div><span class="sc-bEjUoa lhyyLL"> <!-- -->Default:<!-- --> </span> <span class="sc-bEjUoa sc-dTWiOz lhyyLL kMQdIk">20</span></div> <div><div html="<p>Number of results per page</p>
|
|
565
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Number of results per page</p>
|
|
566
|
+
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">200<!-- --> </strong><div html="<p>List of users</p>
|
|
567
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>List of users</p>
|
|
568
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Authentication required</p>
|
|
569
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
570
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="get" class="sc-fQLpxn dynMBc http-verb get">get</span><span class="sc-jvKoal kZcHWP">/users</span><svg class="sc-dntSTA iuNpUs" 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-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/users</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R1759q»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R1759q»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«R1759q»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R1759q»1" data-rttab="true">401</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R1759q»0" aria-labelledby="tab«R1759q»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><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">"users"</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 string">"a1b2c3d4-e5f6-7890-1234-567890abcdef"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"displayName"</span>: <span class="token string">"Alex Chen"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"email"</span>: <span class="token string">"alex.chen@example.com"</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">"pagination"</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">"total"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"page"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"limit"</span>: <span class="token number">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 class="react-tabs__tab-panel" role="tabpanel" id="panel«R1759q»1" aria-labelledby="tab«R1759q»1"></div></div></div></div></div></div><div id="tag/Users/operation/getUser" data-section-id="tag/Users/operation/getUser" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/getUser" id="operation/getUser" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Users/operation/getUser" aria-label="tag/Users/operation/getUser"></a>Get user details<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Returns the details of a specific user by their ID.</p>
|
|
571
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Returns the details of a specific user by their ID.</p>
|
|
572
|
+
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">path<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="userId" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">userId</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq"> <!-- --><<!-- -->uuid<!-- -->><!-- --> </span></div> <div><div html="<p>The unique identifier (UUID) of the user.</p>
|
|
573
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The unique identifier (UUID) of the user.</p>
|
|
574
|
+
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">200<!-- --> </strong><div html="<p>User details</p>
|
|
575
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>User details</p>
|
|
576
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Authentication required</p>
|
|
577
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
578
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">404<!-- --> </strong><div html="<p>Resource not found</p>
|
|
579
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Resource not found</p>
|
|
580
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="get" class="sc-fQLpxn dynMBc http-verb get">get</span><span class="sc-jvKoal kZcHWP">/users/{userId}</span><svg class="sc-dntSTA iuNpUs" 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-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/users/{userId}</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R175pq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R175pq»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«R175pq»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R175pq»1" data-rttab="true">401</li><li class="tab-error" role="tab" id="tab«R175pq»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R175pq»2" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R175pq»0" aria-labelledby="tab«R175pq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><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 string">"a1b2c3d4-e5f6-7890-1234-567890abcdef"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"displayName"</span>: <span class="token string">"Alex Chen"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"email"</span>: <span class="token string">"alex.chen@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token string">"2025-04-15T12:05:00Z"</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="panel«R175pq»1" aria-labelledby="tab«R175pq»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R175pq»2" aria-labelledby="tab«R175pq»2"></div></div></div></div></div></div><div id="tag/Users/operation/listGroupEntities" data-section-id="tag/Users/operation/listGroupEntities" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/listGroupEntities" id="operation/listGroupEntities" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Users/operation/listGroupEntities" aria-label="tag/Users/operation/listGroupEntities"></a>List entities in a group<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Returns a list of all entities (users, systems, etc.) that belong to a specific group, including their roles.</p>
|
|
581
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Returns a list of all entities (users, systems, etc.) that belong to a specific group, including their roles.</p>
|
|
582
|
+
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">path<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="groupId" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">groupId</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq"> <!-- --><<!-- -->uuid<!-- -->><!-- --> </span></div> <div><div html="<p>The unique identifier (UUID) of the group.</p>
|
|
583
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The unique identifier (UUID) of the group.</p>
|
|
584
|
+
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-eqYatC czjApA">query<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class=""><td kind="field" title="page" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">page</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">integer</span></div><div><span class="sc-bEjUoa lhyyLL"> <!-- -->Default:<!-- --> </span> <span class="sc-bEjUoa sc-dTWiOz lhyyLL kMQdIk">1</span></div> <div><div html="<p>Page number for pagination</p>
|
|
585
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Page number for pagination</p>
|
|
586
|
+
</div></div></div></td></tr><tr class="last "><td kind="field" title="limit" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">limit</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">integer</span></div><div><span class="sc-bEjUoa lhyyLL"> <!-- -->Default:<!-- --> </span> <span class="sc-bEjUoa sc-dTWiOz lhyyLL kMQdIk">20</span></div> <div><div html="<p>Number of results per page</p>
|
|
587
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Number of results per page</p>
|
|
588
|
+
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">200<!-- --> </strong><div html="<p>List of entities in the group</p>
|
|
589
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>List of entities in the group</p>
|
|
590
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Authentication required</p>
|
|
591
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
592
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">404<!-- --> </strong><div html="<p>Resource not found</p>
|
|
593
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Resource not found</p>
|
|
594
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="get" class="sc-fQLpxn dynMBc http-verb get">get</span><span class="sc-jvKoal kZcHWP">/groups/{groupId}/entities</span><svg class="sc-dntSTA iuNpUs" 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-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/groups/{groupId}/entities</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R1769q»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R1769q»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«R1769q»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R1769q»1" data-rttab="true">401</li><li class="tab-error" role="tab" id="tab«R1769q»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R1769q»2" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R1769q»0" aria-labelledby="tab«R1769q»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><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">"entities"</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">"entity"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"entityType"</span>: <span class="token string">"human"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"entityId"</span>: <span class="token string">"a1b2c3d4-e5f6-7890-1234-567890abcdef"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"role"</span>: <span class="token string">"approver"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"addedAt"</span>: <span class="token string">"2025-04-16T10:30:00Z"</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">"pagination"</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">"total"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"page"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"limit"</span>: <span class="token number">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 class="react-tabs__tab-panel" role="tabpanel" id="panel«R1769q»1" aria-labelledby="tab«R1769q»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R1769q»2" aria-labelledby="tab«R1769q»2"></div></div></div></div></div></div><div id="tag/Users/operation/addGroupEntities" data-section-id="tag/Users/operation/addGroupEntities" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/addGroupEntities" id="operation/addGroupEntities" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Users/operation/addGroupEntities" aria-label="tag/Users/operation/addGroupEntities"></a>Add group entities<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Add entities (like users) within a specific group.</p>
|
|
595
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Add entities (like users) within a specific group.</p>
|
|
596
|
+
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">path<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="groupId" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">groupId</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq"> <!-- --><<!-- -->uuid<!-- -->><!-- --> </span></div> <div><div html="<p>The unique identifier (UUID) of the group.</p>
|
|
597
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The unique identifier (UUID) of the group.</p>
|
|
598
|
+
</div></div></div></td></tr></tbody></table></div><h5 class="sc-eqYatC czjApA">Request Body schema: <span class="sc-dNFkOE cFlAeY">application/json</span><div class="sc-bEjUoa sc-iIvHqT sc-eTCgfj lhyyLL crXmiY foplsk">required</div></h5><div html="" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"></div><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="entities" class="sc-kCuUfV sc-fbQrwq sc-itBLYH gdmNWp dFOJWJ kdPQHX"><span class="sc-hwddKA cteAyA"></span><button aria-label="expand entities"><span class="property-name">entities</span><svg class="sc-dntSTA dOPmTa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="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 class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP">Array of </span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">objects</span><span class="sc-bEjUoa sc-hdBJTi lhyyLL nwQTz"> (<!-- -->EntityMembershipAdd<!-- -->) </span></div> <div><div html="<p>List of entities to add to the group.</p>
|
|
599
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>List of entities to add to the group.</p>
|
|
600
|
+
</div></div></div></td></tr></tbody></table><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">200<!-- --> </strong><div html="<p>Entities managed successfully. Returns updated group details.</p>
|
|
601
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Entities managed successfully. Returns updated group details.</p>
|
|
602
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">400<!-- --> </strong><div html="<p>Invalid request</p>
|
|
603
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Invalid request</p>
|
|
604
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Authentication required</p>
|
|
605
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
606
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">404<!-- --> </strong><div html="<p>Group not found</p>
|
|
607
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Group not found</p>
|
|
608
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">409<!-- --> </strong><div html="<p>Conflict detected (e.g., adding an existing member).</p>
|
|
609
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Conflict detected (e.g., adding an existing member).</p>
|
|
610
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="post" class="sc-fQLpxn kwcmyC http-verb post">post</span><span class="sc-jvKoal kZcHWP">/groups/{groupId}/entities</span><svg class="sc-dntSTA iuNpUs" 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-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/groups/{groupId}/entities</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Request samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«R156pq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R156pq»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R156pq»0" aria-labelledby="tab«R156pq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><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">"entities"</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">"entity"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"entityType"</span>: <span class="token string">"human"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"entityId"</span>: <span class="token string">"a1b2c3d4-e5f6-7890-1234-567890abcdef"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"role"</span>: <span class="token string">"approver"</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-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R176pq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R176pq»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«R176pq»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R176pq»1" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab«R176pq»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R176pq»2" data-rttab="true">401</li><li class="tab-error" role="tab" id="tab«R176pq»3" aria-selected="false" aria-disabled="false" aria-controls="panel«R176pq»3" data-rttab="true">404</li><li class="tab-error" role="tab" id="tab«R176pq»4" aria-selected="false" aria-disabled="false" aria-controls="panel«R176pq»4" data-rttab="true">409</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R176pq»0" aria-labelledby="tab«R176pq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><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 string">"497f6eca-6276-4993-bfeb-53cbbbba6f08"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"entitiesCount"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"updatedAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</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="panel«R176pq»1" aria-labelledby="tab«R176pq»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R176pq»2" aria-labelledby="tab«R176pq»2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R176pq»3" aria-labelledby="tab«R176pq»3"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R176pq»4" aria-labelledby="tab«R176pq»4"></div></div></div></div></div></div><div id="tag/Users/operation/removeGroupEntities" data-section-id="tag/Users/operation/removeGroupEntities" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/removeGroupEntities" id="operation/removeGroupEntities" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Users/operation/removeGroupEntities" aria-label="tag/Users/operation/removeGroupEntities"></a>Remove group entities<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Remove entities (like users) from a specific group.</p>
|
|
611
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Remove entities (like users) from a specific group.</p>
|
|
612
|
+
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">path<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="groupId" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">groupId</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq"> <!-- --><<!-- -->uuid<!-- -->><!-- --> </span></div> <div><div html="<p>The unique identifier (UUID) of the group.</p>
|
|
613
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The unique identifier (UUID) of the group.</p>
|
|
614
|
+
</div></div></div></td></tr></tbody></table></div><h5 class="sc-eqYatC czjApA">Request Body schema: <span class="sc-dNFkOE cFlAeY">application/json</span><div class="sc-bEjUoa sc-iIvHqT sc-eTCgfj lhyyLL crXmiY foplsk">required</div></h5><div html="" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"></div><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="entities" class="sc-kCuUfV sc-fbQrwq sc-itBLYH gdmNWp dFOJWJ kdPQHX"><span class="sc-hwddKA cteAyA"></span><button aria-label="expand entities"><span class="property-name">entities</span><svg class="sc-dntSTA dOPmTa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="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 class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP">Array of </span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">objects</span><span class="sc-bEjUoa sc-hdBJTi lhyyLL nwQTz"> (<!-- -->EntityMembershipRemove<!-- -->) </span></div> <div><div html="<p>List of entities to remove from the group.</p>
|
|
615
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>List of entities to remove from the group.</p>
|
|
616
|
+
</div></div></div></td></tr></tbody></table><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">200<!-- --> </strong><div html="<p>Entities removed successfully. Returns updated group details.</p>
|
|
617
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Entities removed successfully. Returns updated group details.</p>
|
|
618
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">400<!-- --> </strong><div html="<p>Invalid request</p>
|
|
619
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Invalid request</p>
|
|
620
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Authentication required</p>
|
|
621
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
622
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">404<!-- --> </strong><div html="<p>Group not found</p>
|
|
623
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Group not found</p>
|
|
624
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">409<!-- --> </strong><div html="<p>Conflict detected (e.g. removing a non-member).</p>
|
|
625
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Conflict detected (e.g. removing a non-member).</p>
|
|
626
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="delete" class="sc-fQLpxn gKcHYQ http-verb delete">delete</span><span class="sc-jvKoal kZcHWP">/groups/{groupId}/entities</span><svg class="sc-dntSTA iuNpUs" 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-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/groups/{groupId}/entities</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Request samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«R1579q»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R1579q»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R1579q»0" aria-labelledby="tab«R1579q»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><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">"entities"</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">"entity"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"entityType"</span>: <span class="token string">"human"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"entityId"</span>: <span class="token string">"a1b2c3d4-e5f6-7890-1234-567890abcdef"</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-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R1779q»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R1779q»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«R1779q»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R1779q»1" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab«R1779q»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R1779q»2" data-rttab="true">401</li><li class="tab-error" role="tab" id="tab«R1779q»3" aria-selected="false" aria-disabled="false" aria-controls="panel«R1779q»3" data-rttab="true">404</li><li class="tab-error" role="tab" id="tab«R1779q»4" aria-selected="false" aria-disabled="false" aria-controls="panel«R1779q»4" data-rttab="true">409</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R1779q»0" aria-labelledby="tab«R1779q»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><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 string">"497f6eca-6276-4993-bfeb-53cbbbba6f08"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"entitiesCount"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"updatedAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</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="panel«R1779q»1" aria-labelledby="tab«R1779q»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R1779q»2" aria-labelledby="tab«R1779q»2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R1779q»3" aria-labelledby="tab«R1779q»3"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R1779q»4" aria-labelledby="tab«R1779q»4"></div></div></div></div></div></div><div id="tag/Groups" data-section-id="tag/Groups" class="sc-dTvVRJ bPmFpz"><div class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Groups" aria-label="tag/Groups"></a>Groups</h2></div></div><div class="sc-ggWZvA dCzIPc"><div class="sc-eVqvcJ sc-fszimp kIppRw kbZred redoc-markdown " html="<p>Group management</p>
|
|
627
|
+
"><p>Group management</p>
|
|
628
|
+
</div></div></div><div id="tag/Groups/operation/createGroup" data-section-id="tag/Groups/operation/createGroup" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/createGroup" id="operation/createGroup" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Groups/operation/createGroup" aria-label="tag/Groups/operation/createGroup"></a>Create a new approver group<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Create a new group for organizing approvers</p>
|
|
629
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Create a new group for organizing approvers</p>
|
|
630
|
+
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><h5 class="sc-eqYatC czjApA">Request Body schema: <span class="sc-dNFkOE cFlAeY">application/json</span><div class="sc-bEjUoa sc-iIvHqT sc-eTCgfj lhyyLL crXmiY foplsk">required</div></h5><div html="" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"></div><table class="sc-eqNDNG icJLQx"><tbody><tr class=""><td kind="field" title="name" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">name</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="<p>Name of the group</p>
|
|
631
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Name of the group</p>
|
|
632
|
+
</div></div></div></td></tr><tr class="last "><td kind="field" title="description" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">description</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="<p>Description of the group</p>
|
|
633
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Description of the group</p>
|
|
634
|
+
</div></div></div></td></tr></tbody></table><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">201<!-- --> </strong><div html="<p>Group created successfully</p>
|
|
635
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Group created successfully</p>
|
|
636
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">400<!-- --> </strong><div html="<p>Invalid request</p>
|
|
637
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Invalid request</p>
|
|
638
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Authentication required</p>
|
|
639
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
640
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="post" class="sc-fQLpxn kwcmyC http-verb post">post</span><span class="sc-jvKoal kZcHWP">/groups</span><svg class="sc-dntSTA iuNpUs" 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-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/groups</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Request samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«R154qa»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R154qa»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R154qa»0" aria-labelledby="tab«R154qa»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><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">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</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><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R174qa»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R174qa»0" tabindex="0" data-rttab="true">201</li><li class="tab-error" role="tab" id="tab«R174qa»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R174qa»1" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab«R174qa»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R174qa»2" data-rttab="true">401</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R174qa»0" aria-labelledby="tab«R174qa»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><span class="token punctuation">{ }</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R174qa»1" aria-labelledby="tab«R174qa»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R174qa»2" aria-labelledby="tab«R174qa»2"></div></div></div></div></div></div><div id="tag/Groups/operation/listGroups" data-section-id="tag/Groups/operation/listGroups" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/listGroups" id="operation/listGroups" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Groups/operation/listGroups" aria-label="tag/Groups/operation/listGroups"></a>List groups<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Returns a list of groups</p>
|
|
641
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Returns a list of groups</p>
|
|
642
|
+
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">query<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class=""><td kind="field" title="page" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">page</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">integer</span></div><div><span class="sc-bEjUoa lhyyLL"> <!-- -->Default:<!-- --> </span> <span class="sc-bEjUoa sc-dTWiOz lhyyLL kMQdIk">1</span></div> <div><div html="<p>Page number for pagination</p>
|
|
643
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Page number for pagination</p>
|
|
644
|
+
</div></div></div></td></tr><tr class="last "><td kind="field" title="limit" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">limit</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">integer</span></div><div><span class="sc-bEjUoa lhyyLL"> <!-- -->Default:<!-- --> </span> <span class="sc-bEjUoa sc-dTWiOz lhyyLL kMQdIk">20</span></div> <div><div html="<p>Number of results per page</p>
|
|
645
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Number of results per page</p>
|
|
646
|
+
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">200<!-- --> </strong><div html="<p>List of groups</p>
|
|
647
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>List of groups</p>
|
|
648
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Authentication required</p>
|
|
649
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
650
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="get" class="sc-fQLpxn dynMBc http-verb get">get</span><span class="sc-jvKoal kZcHWP">/groups</span><svg class="sc-dntSTA iuNpUs" 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-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/groups</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R175aa»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R175aa»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«R175aa»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R175aa»1" data-rttab="true">401</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R175aa»0" aria-labelledby="tab«R175aa»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><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">"groups"</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 string">"497f6eca-6276-4993-bfeb-53cbbbba6f08"</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">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"entitiesCount"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"updatedAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</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">"pagination"</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">"total"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"page"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"limit"</span>: <span class="token number">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 class="react-tabs__tab-panel" role="tabpanel" id="panel«R175aa»1" aria-labelledby="tab«R175aa»1"></div></div></div></div></div></div><div id="tag/Groups/operation/getGroup" data-section-id="tag/Groups/operation/getGroup" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/getGroup" id="operation/getGroup" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Groups/operation/getGroup" aria-label="tag/Groups/operation/getGroup"></a>Get group details<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Returns the details of a specific group</p>
|
|
651
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Returns the details of a specific group</p>
|
|
652
|
+
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">path<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="groupIdentifier" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">groupIdentifier</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="<p>The unique identifier of the group or the name of the group</p>
|
|
653
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The unique identifier of the group or the name of the group</p>
|
|
654
|
+
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">200<!-- --> </strong><div html="<p>Group details</p>
|
|
655
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Group details</p>
|
|
656
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Authentication required</p>
|
|
657
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
658
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">404<!-- --> </strong><div html="<p>Resource not found</p>
|
|
659
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Resource not found</p>
|
|
660
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="get" class="sc-fQLpxn dynMBc http-verb get">get</span><span class="sc-jvKoal kZcHWP">/groups/{groupIdentifier}</span><svg class="sc-dntSTA iuNpUs" 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-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/groups/{groupIdentifier}</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R175qa»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R175qa»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«R175qa»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R175qa»1" data-rttab="true">401</li><li class="tab-error" role="tab" id="tab«R175qa»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R175qa»2" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R175qa»0" aria-labelledby="tab«R175qa»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><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 string">"497f6eca-6276-4993-bfeb-53cbbbba6f08"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"entitiesCount"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"updatedAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</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="panel«R175qa»1" aria-labelledby="tab«R175qa»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R175qa»2" aria-labelledby="tab«R175qa»2"></div></div></div></div></div></div><div id="tag/Groups/operation/listGroupEntities" data-section-id="tag/Groups/operation/listGroupEntities" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/listGroupEntities" id="operation/listGroupEntities" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Groups/operation/listGroupEntities" aria-label="tag/Groups/operation/listGroupEntities"></a>List entities in a group<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Returns a list of all entities (users, systems, etc.) that belong to a specific group, including their roles.</p>
|
|
661
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Returns a list of all entities (users, systems, etc.) that belong to a specific group, including their roles.</p>
|
|
662
|
+
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">path<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="groupId" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">groupId</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq"> <!-- --><<!-- -->uuid<!-- -->><!-- --> </span></div> <div><div html="<p>The unique identifier (UUID) of the group.</p>
|
|
663
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The unique identifier (UUID) of the group.</p>
|
|
664
|
+
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-eqYatC czjApA">query<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class=""><td kind="field" title="page" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">page</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">integer</span></div><div><span class="sc-bEjUoa lhyyLL"> <!-- -->Default:<!-- --> </span> <span class="sc-bEjUoa sc-dTWiOz lhyyLL kMQdIk">1</span></div> <div><div html="<p>Page number for pagination</p>
|
|
665
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Page number for pagination</p>
|
|
666
|
+
</div></div></div></td></tr><tr class="last "><td kind="field" title="limit" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">limit</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">integer</span></div><div><span class="sc-bEjUoa lhyyLL"> <!-- -->Default:<!-- --> </span> <span class="sc-bEjUoa sc-dTWiOz lhyyLL kMQdIk">20</span></div> <div><div html="<p>Number of results per page</p>
|
|
667
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Number of results per page</p>
|
|
668
|
+
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">200<!-- --> </strong><div html="<p>List of entities in the group</p>
|
|
669
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>List of entities in the group</p>
|
|
670
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Authentication required</p>
|
|
671
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
672
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">404<!-- --> </strong><div html="<p>Resource not found</p>
|
|
673
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Resource not found</p>
|
|
674
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="get" class="sc-fQLpxn dynMBc http-verb get">get</span><span class="sc-jvKoal kZcHWP">/groups/{groupId}/entities</span><svg class="sc-dntSTA iuNpUs" 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-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/groups/{groupId}/entities</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R176aa»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R176aa»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«R176aa»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R176aa»1" data-rttab="true">401</li><li class="tab-error" role="tab" id="tab«R176aa»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R176aa»2" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R176aa»0" aria-labelledby="tab«R176aa»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><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">"entities"</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">"entity"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"entityType"</span>: <span class="token string">"human"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"entityId"</span>: <span class="token string">"a1b2c3d4-e5f6-7890-1234-567890abcdef"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"role"</span>: <span class="token string">"approver"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"addedAt"</span>: <span class="token string">"2025-04-16T10:30:00Z"</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">"pagination"</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">"total"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"page"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"limit"</span>: <span class="token number">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 class="react-tabs__tab-panel" role="tabpanel" id="panel«R176aa»1" aria-labelledby="tab«R176aa»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R176aa»2" aria-labelledby="tab«R176aa»2"></div></div></div></div></div></div><div id="tag/Groups/operation/addGroupEntities" data-section-id="tag/Groups/operation/addGroupEntities" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/addGroupEntities" id="operation/addGroupEntities" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Groups/operation/addGroupEntities" aria-label="tag/Groups/operation/addGroupEntities"></a>Add group entities<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Add entities (like users) within a specific group.</p>
|
|
675
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Add entities (like users) within a specific group.</p>
|
|
676
|
+
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">path<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="groupId" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">groupId</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq"> <!-- --><<!-- -->uuid<!-- -->><!-- --> </span></div> <div><div html="<p>The unique identifier (UUID) of the group.</p>
|
|
677
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The unique identifier (UUID) of the group.</p>
|
|
678
|
+
</div></div></div></td></tr></tbody></table></div><h5 class="sc-eqYatC czjApA">Request Body schema: <span class="sc-dNFkOE cFlAeY">application/json</span><div class="sc-bEjUoa sc-iIvHqT sc-eTCgfj lhyyLL crXmiY foplsk">required</div></h5><div html="" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"></div><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="entities" class="sc-kCuUfV sc-fbQrwq sc-itBLYH gdmNWp dFOJWJ kdPQHX"><span class="sc-hwddKA cteAyA"></span><button aria-label="expand entities"><span class="property-name">entities</span><svg class="sc-dntSTA dOPmTa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="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 class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP">Array of </span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">objects</span><span class="sc-bEjUoa sc-hdBJTi lhyyLL nwQTz"> (<!-- -->EntityMembershipAdd<!-- -->) </span></div> <div><div html="<p>List of entities to add to the group.</p>
|
|
679
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>List of entities to add to the group.</p>
|
|
680
|
+
</div></div></div></td></tr></tbody></table><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">200<!-- --> </strong><div html="<p>Entities managed successfully. Returns updated group details.</p>
|
|
681
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Entities managed successfully. Returns updated group details.</p>
|
|
682
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">400<!-- --> </strong><div html="<p>Invalid request</p>
|
|
683
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Invalid request</p>
|
|
684
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Authentication required</p>
|
|
685
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
686
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">404<!-- --> </strong><div html="<p>Group not found</p>
|
|
687
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Group not found</p>
|
|
688
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">409<!-- --> </strong><div html="<p>Conflict detected (e.g., adding an existing member).</p>
|
|
689
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Conflict detected (e.g., adding an existing member).</p>
|
|
690
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="post" class="sc-fQLpxn kwcmyC http-verb post">post</span><span class="sc-jvKoal kZcHWP">/groups/{groupId}/entities</span><svg class="sc-dntSTA iuNpUs" 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-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/groups/{groupId}/entities</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Request samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«R156qa»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R156qa»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R156qa»0" aria-labelledby="tab«R156qa»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><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">"entities"</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">"entity"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"entityType"</span>: <span class="token string">"human"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"entityId"</span>: <span class="token string">"a1b2c3d4-e5f6-7890-1234-567890abcdef"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"role"</span>: <span class="token string">"approver"</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-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R176qa»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R176qa»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«R176qa»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R176qa»1" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab«R176qa»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R176qa»2" data-rttab="true">401</li><li class="tab-error" role="tab" id="tab«R176qa»3" aria-selected="false" aria-disabled="false" aria-controls="panel«R176qa»3" data-rttab="true">404</li><li class="tab-error" role="tab" id="tab«R176qa»4" aria-selected="false" aria-disabled="false" aria-controls="panel«R176qa»4" data-rttab="true">409</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R176qa»0" aria-labelledby="tab«R176qa»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><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 string">"497f6eca-6276-4993-bfeb-53cbbbba6f08"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"entitiesCount"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"updatedAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</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="panel«R176qa»1" aria-labelledby="tab«R176qa»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R176qa»2" aria-labelledby="tab«R176qa»2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R176qa»3" aria-labelledby="tab«R176qa»3"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R176qa»4" aria-labelledby="tab«R176qa»4"></div></div></div></div></div></div><div id="tag/Groups/operation/removeGroupEntities" data-section-id="tag/Groups/operation/removeGroupEntities" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/removeGroupEntities" id="operation/removeGroupEntities" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Groups/operation/removeGroupEntities" aria-label="tag/Groups/operation/removeGroupEntities"></a>Remove group entities<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Remove entities (like users) from a specific group.</p>
|
|
691
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Remove entities (like users) from a specific group.</p>
|
|
692
|
+
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">path<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="groupId" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">groupId</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq"> <!-- --><<!-- -->uuid<!-- -->><!-- --> </span></div> <div><div html="<p>The unique identifier (UUID) of the group.</p>
|
|
693
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The unique identifier (UUID) of the group.</p>
|
|
694
|
+
</div></div></div></td></tr></tbody></table></div><h5 class="sc-eqYatC czjApA">Request Body schema: <span class="sc-dNFkOE cFlAeY">application/json</span><div class="sc-bEjUoa sc-iIvHqT sc-eTCgfj lhyyLL crXmiY foplsk">required</div></h5><div html="" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"></div><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="entities" class="sc-kCuUfV sc-fbQrwq sc-itBLYH gdmNWp dFOJWJ kdPQHX"><span class="sc-hwddKA cteAyA"></span><button aria-label="expand entities"><span class="property-name">entities</span><svg class="sc-dntSTA dOPmTa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="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 class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP">Array of </span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">objects</span><span class="sc-bEjUoa sc-hdBJTi lhyyLL nwQTz"> (<!-- -->EntityMembershipRemove<!-- -->) </span></div> <div><div html="<p>List of entities to remove from the group.</p>
|
|
695
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>List of entities to remove from the group.</p>
|
|
696
|
+
</div></div></div></td></tr></tbody></table><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">200<!-- --> </strong><div html="<p>Entities removed successfully. Returns updated group details.</p>
|
|
697
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Entities removed successfully. Returns updated group details.</p>
|
|
698
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">400<!-- --> </strong><div html="<p>Invalid request</p>
|
|
699
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Invalid request</p>
|
|
700
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Authentication required</p>
|
|
701
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
702
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">404<!-- --> </strong><div html="<p>Group not found</p>
|
|
703
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Group not found</p>
|
|
704
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">409<!-- --> </strong><div html="<p>Conflict detected (e.g. removing a non-member).</p>
|
|
705
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Conflict detected (e.g. removing a non-member).</p>
|
|
706
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="delete" class="sc-fQLpxn gKcHYQ http-verb delete">delete</span><span class="sc-jvKoal kZcHWP">/groups/{groupId}/entities</span><svg class="sc-dntSTA iuNpUs" 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-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/groups/{groupId}/entities</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Request samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«R157aa»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R157aa»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R157aa»0" aria-labelledby="tab«R157aa»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><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">"entities"</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">"entity"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"entityType"</span>: <span class="token string">"human"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"entityId"</span>: <span class="token string">"a1b2c3d4-e5f6-7890-1234-567890abcdef"</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-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R177aa»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R177aa»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«R177aa»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R177aa»1" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab«R177aa»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R177aa»2" data-rttab="true">401</li><li class="tab-error" role="tab" id="tab«R177aa»3" aria-selected="false" aria-disabled="false" aria-controls="panel«R177aa»3" data-rttab="true">404</li><li class="tab-error" role="tab" id="tab«R177aa»4" aria-selected="false" aria-disabled="false" aria-controls="panel«R177aa»4" data-rttab="true">409</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R177aa»0" aria-labelledby="tab«R177aa»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><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 string">"497f6eca-6276-4993-bfeb-53cbbbba6f08"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"entitiesCount"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"updatedAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</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="panel«R177aa»1" aria-labelledby="tab«R177aa»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R177aa»2" aria-labelledby="tab«R177aa»2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R177aa»3" aria-labelledby="tab«R177aa»3"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R177aa»4" aria-labelledby="tab«R177aa»4"></div></div></div></div></div></div><div id="tag/Workflow-Actions" data-section-id="tag/Workflow-Actions" class="sc-dTvVRJ bPmFpz"><div class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Workflow-Actions" aria-label="tag/Workflow-Actions"></a>Workflow Actions</h2></div></div><div class="sc-ggWZvA dCzIPc"><div class="sc-eVqvcJ sc-fszimp kIppRw kbZred redoc-markdown " html="<p>Workflow actions and voting</p>
|
|
707
|
+
"><p>Workflow actions and voting</p>
|
|
708
|
+
</div></div></div><div id="tag/Workflow-Actions/operation/voteOnWorkflow" data-section-id="tag/Workflow-Actions/operation/voteOnWorkflow" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/voteOnWorkflow" id="operation/voteOnWorkflow" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Workflow-Actions/operation/voteOnWorkflow" aria-label="tag/Workflow-Actions/operation/voteOnWorkflow"></a>Vote on a workflow<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Allows an authenticated entity to cast a vote (approve or veto) on a specific workflow.</p>
|
|
709
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Allows an authenticated entity to cast a vote (approve or veto) on a specific workflow.</p>
|
|
710
|
+
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">path<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="workflowId" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">workflowId</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="<p>The unique identifier of the workflow</p>
|
|
711
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The unique identifier of the workflow</p>
|
|
712
|
+
</div></div></div></td></tr></tbody></table></div><h5 class="sc-eqYatC czjApA">Request Body schema: <span class="sc-dNFkOE cFlAeY">application/json</span><div class="sc-bEjUoa sc-iIvHqT sc-eTCgfj lhyyLL crXmiY foplsk">required</div></h5><div html="" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"></div><table class="sc-eqNDNG icJLQx"><tbody><tr class=""><td kind="field" title="reason" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">reason</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="<p>Optional reason for the vote. Can be used for approval comments or reject reasons.</p>
|
|
713
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Optional reason for the vote. Can be used for approval comments or reject reasons.</p>
|
|
714
|
+
</div></div></div></td></tr><tr class="last "><td kind="field" title="voteType" class="sc-kCuUfV sc-fbQrwq sc-itBLYH gdmNWp dFOJWJ kdPQHX"><span class="sc-hwddKA cteAyA"></span><button aria-label="expand voteType"><span class="property-name">voteType</span><svg class="sc-dntSTA dOPmTa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="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 class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">any</span></div> <div><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div></div></div></td></tr></tbody></table><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">200<!-- --> </strong><div html="<p>Vote cast successfully. Returns updated workflow details.</p>
|
|
715
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Vote cast successfully. Returns updated workflow details.</p>
|
|
716
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">400<!-- --> </strong><div html="<p>Invalid request (e.g., voter not authorized, invalid vote type/mode).</p>
|
|
717
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Invalid request (e.g., voter not authorized, invalid vote type/mode).</p>
|
|
718
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Authentication required</p>
|
|
719
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
720
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">404<!-- --> </strong><div html="<p>Resource not found</p>
|
|
721
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Resource not found</p>
|
|
722
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="post" class="sc-fQLpxn kwcmyC http-verb post">post</span><span class="sc-jvKoal kZcHWP">/workflows/{workflowId}/vote</span><svg class="sc-dntSTA iuNpUs" 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-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/workflows/{workflowId}/vote</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Request samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«Riiqq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«Riiqq»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«Riiqq»0" aria-labelledby="tab«Riiqq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><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">"reason"</span>: <span class="token string">"Missing critical information or LGTM!"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"voteType"</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">"type"</span>: <span class="token string">"APPROVE"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"votedForGroups"</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">"a1b2c3d4-e5f6-7890-1234-567890abcdef"</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-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«Rjiqq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«Rjiqq»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«Rjiqq»1" aria-selected="false" aria-disabled="false" aria-controls="panel«Rjiqq»1" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab«Rjiqq»2" aria-selected="false" aria-disabled="false" aria-controls="panel«Rjiqq»2" data-rttab="true">401</li><li class="tab-error" role="tab" id="tab«Rjiqq»3" aria-selected="false" aria-disabled="false" aria-controls="panel«Rjiqq»3" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«Rjiqq»0" aria-labelledby="tab«Rjiqq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><span class="token punctuation">{ }</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«Rjiqq»1" aria-labelledby="tab«Rjiqq»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«Rjiqq»2" aria-labelledby="tab«Rjiqq»2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«Rjiqq»3" aria-labelledby="tab«Rjiqq»3"></div></div></div></div></div></div><div id="tag/Workflow-Actions/operation/canVoteOnWorkflow" data-section-id="tag/Workflow-Actions/operation/canVoteOnWorkflow" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/canVoteOnWorkflow" id="operation/canVoteOnWorkflow" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Workflow-Actions/operation/canVoteOnWorkflow" aria-label="tag/Workflow-Actions/operation/canVoteOnWorkflow"></a>Check if the current entity can vote on a workflow<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Determines if the authenticated entity is eligible to cast a vote on the specified workflow.</p>
|
|
723
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Determines if the authenticated entity is eligible to cast a vote on the specified workflow.</p>
|
|
724
|
+
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">path<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="workflowId" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">workflowId</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="<p>The unique identifier of the workflow.</p>
|
|
725
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The unique identifier of the workflow.</p>
|
|
726
|
+
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">200<!-- --> </strong><div html="<p>Eligibility to vote confirmed.</p>
|
|
727
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Eligibility to vote confirmed.</p>
|
|
728
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Authentication required</p>
|
|
729
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
730
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">404<!-- --> </strong><div html="<p>Resource not found</p>
|
|
731
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Resource not found</p>
|
|
732
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="get" class="sc-fQLpxn dynMBc http-verb get">get</span><span class="sc-jvKoal kZcHWP">/workflows/{workflowId}/canVote</span><svg class="sc-dntSTA iuNpUs" 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-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/workflows/{workflowId}/canVote</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«Rjjaq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«Rjjaq»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«Rjjaq»1" aria-selected="false" aria-disabled="false" aria-controls="panel«Rjjaq»1" data-rttab="true">401</li><li class="tab-error" role="tab" id="tab«Rjjaq»2" aria-selected="false" aria-disabled="false" aria-controls="panel«Rjjaq»2" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«Rjjaq»0" aria-labelledby="tab«Rjjaq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><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">"canVote"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"voteStatus"</span>: <span class="token string">"VOTE_PENDING"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"cantVoteReason"</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="panel«Rjjaq»1" aria-labelledby="tab«Rjjaq»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«Rjjaq»2" aria-labelledby="tab«Rjjaq»2"></div></div></div></div></div></div></div><div class="sc-evkzZa iZqpqg"></div></div></div>
|
|
733
|
+
<script>
|
|
734
|
+
const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.0.0","info":{"title":"Workflow Approval System API","description":"API for a SaaS platform that allows customers to manage approvals for generic workflows, users, and groups.","version":"0.0.6"},"tags":[{"name":"Workflows","description":"Workflow management and approval"},{"name":"Workflow Templates","description":"Workflow template management"},{"name":"Users","description":"User management"},{"name":"Groups","description":"Group management"},{"name":"Workflow Actions","description":"Workflow actions and voting"}],"paths":{"/workflows":{"post":{"summary":"Create a new workflow","description":"Creates a new workflow with approvers and rules","operationId":"createWorkflow","tags":["Workflows"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowCreate"}}}},"responses":{"201":{"description":"Workflow created successfully","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"}}},"get":{"summary":"List workflows","description":"Returns a list of workflows with optional filtering","operationId":"listWorkflows","tags":["Workflows"],"parameters":[{"name":"page","in":"query","description":"Page number for pagination","schema":{"type":"integer","default":1}},{"name":"limit","in":"query","description":"Number of results per page","schema":{"type":"integer","default":20}},{"name":"include","in":"query","description":"Comma-separated list of related objects to include in the response","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["workflow-template"]}}}],"responses":{"200":{"description":"List of workflows","content":{"application/json":{"schema":{"type":"object","required":["data","pagination"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Workflow"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}},"/workflows/{workflowId}":{"get":{"summary":"Get workflow details","description":"Returns the details of a specific workflow","operationId":"getWorkflow","tags":["Workflows"],"parameters":[{"name":"workflowId","in":"path","required":true,"description":"The unique identifier of the workflow","schema":{"type":"string"}},{"name":"include","in":"query","description":"Comma-separated list of related objects to include in the response","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["workflow-template"]}}}],"responses":{"200":{"description":"Workflow details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workflow"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/workflows/{workflowId}/vote":{"post":{"summary":"Vote on a workflow","description":"Allows an authenticated entity to cast a vote (approve or veto) on a specific workflow.","operationId":"voteOnWorkflow","tags":["Workflow Actions"],"parameters":[{"name":"workflowId","in":"path","required":true,"description":"The unique identifier of the workflow","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowVoteRequest"}}}},"responses":{"200":{"description":"Vote cast successfully. Returns updated workflow details.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid request (e.g., voter not authorized, invalid vote type/mode).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/workflows/{workflowId}/canVote":{"get":{"summary":"Check if the current entity can vote on a workflow","description":"Determines if the authenticated entity is eligible to cast a vote on the specified workflow.","operationId":"canVoteOnWorkflow","tags":["Workflow Actions"],"parameters":[{"name":"workflowId","in":"path","required":true,"description":"The unique identifier of the workflow.","schema":{"type":"string"}}],"responses":{"200":{"description":"Eligibility to vote confirmed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CanVoteResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/users":{"post":{"summary":"Create a new user","description":"Creates a new user in the system.","operationId":"createUser","tags":["Users"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserCreate"}}}},"responses":{"201":{"description":"User created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"409":{"description":"User with this email already exists","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}}}},"get":{"summary":"List users","description":"Returns a list of users","operationId":"listUsers","tags":["Users"],"parameters":[{"name":"search","in":"query","description":"Fuzzy search term for user display name or email.","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page number for pagination","schema":{"type":"integer","default":1}},{"name":"limit","in":"query","description":"Number of results per page","schema":{"type":"integer","default":20}}],"responses":{"200":{"description":"List of users","content":{"application/json":{"schema":{"type":"object","required":["users","pagination"],"properties":{"users":{"type":"array","items":{"$ref":"#/components/schemas/UserSummary"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}},"/users/{userId}":{"get":{"summary":"Get user details","description":"Returns the details of a specific user by their ID.","operationId":"getUser","tags":["Users"],"parameters":[{"name":"userId","in":"path","required":true,"description":"The unique identifier (UUID) of the user.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"User details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/groups":{"post":{"summary":"Create a new approver group","description":"Create a new group for organizing approvers","operationId":"createGroup","tags":["Groups"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupCreate"}}}},"responses":{"201":{"description":"Group created successfully","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"}}},"get":{"summary":"List groups","description":"Returns a list of groups","operationId":"listGroups","tags":["Groups"],"parameters":[{"name":"page","in":"query","description":"Page number for pagination","schema":{"type":"integer","default":1}},{"name":"limit","in":"query","description":"Number of results per page","schema":{"type":"integer","default":20}}],"responses":{"200":{"description":"List of groups","content":{"application/json":{"schema":{"type":"object","properties":{"groups":{"type":"array","items":{"$ref":"#/components/schemas/Group"}},"pagination":{"$ref":"#/components/schemas/Pagination"}},"required":["groups","pagination"]}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}},"/groups/{groupIdentifier}":{"get":{"summary":"Get group details","description":"Returns the details of a specific group","operationId":"getGroup","tags":["Groups"],"parameters":[{"name":"groupIdentifier","in":"path","required":true,"description":"The unique identifier of the group or the name of the group","schema":{"type":"string"}}],"responses":{"200":{"description":"Group details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/groups/{groupId}/entities":{"get":{"summary":"List entities in a group","description":"Returns a list of all entities (users, systems, etc.) that belong to a specific group, including their roles.","operationId":"listGroupEntities","tags":["Groups","Users"],"parameters":[{"name":"groupId","in":"path","required":true,"description":"The unique identifier (UUID) of the group.","schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","description":"Page number for pagination","schema":{"type":"integer","default":1}},{"name":"limit","in":"query","description":"Number of results per page","schema":{"type":"integer","default":20}}],"responses":{"200":{"description":"List of entities in the group","content":{"application/json":{"schema":{"type":"object","required":["entities","pagination"],"properties":{"entities":{"type":"array","items":{"$ref":"#/components/schemas/GroupMembership"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}}},"post":{"summary":"Add group entities","description":"Add entities (like users) within a specific group.","operationId":"addGroupEntities","tags":["Groups","Users"],"parameters":[{"name":"groupId","in":"path","required":true,"description":"The unique identifier (UUID) of the group.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddGroupEntitiesRequest"}}}},"responses":{"200":{"description":"Entities managed successfully. Returns updated group details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"description":"Group not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}},"409":{"description":"Conflict detected (e.g., adding an existing member).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}}}},"delete":{"summary":"Remove group entities","description":"Remove entities (like users) from a specific group.","operationId":"removeGroupEntities","tags":["Groups","Users"],"parameters":[{"name":"groupId","in":"path","required":true,"description":"The unique identifier (UUID) of the group.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveGroupEntitiesRequest"}}}},"responses":{"200":{"description":"Entities removed successfully. Returns updated group details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"description":"Group not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}},"409":{"description":"Conflict detected (e.g. removing a non-member).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}}}}},"/workflow-templates":{"post":{"summary":"Create a new workflow template","description":"Creates a new workflow template with approval rules, actions, and default expiry settings","operationId":"createWorkflowTemplate","tags":["Workflow Templates"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowTemplateCreate"}}}},"responses":{"201":{"description":"Workflow template created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowTemplate"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"}}},"get":{"summary":"List workflow templates","description":"Returns a list of workflow templates with optional filtering","operationId":"listWorkflowTemplates","tags":["Workflow Templates"],"parameters":[{"name":"page","in":"query","description":"Page number for pagination","schema":{"type":"integer","default":1}},{"name":"limit","in":"query","description":"Number of results per page","schema":{"type":"integer","default":20}}],"responses":{"200":{"description":"List of workflow templates","content":{"application/json":{"schema":{"type":"object","required":["data","pagination"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowTemplateSummary"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}},"/workflow-templates/{templateId}":{"get":{"summary":"Get workflow template details","description":"Returns the details of a specific workflow template","operationId":"getWorkflowTemplate","tags":["Workflow Templates"],"parameters":[{"name":"templateId","in":"path","required":true,"description":"The unique identifier of the workflow template","schema":{"type":"string"}}],"responses":{"200":{"description":"Workflow template details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowTemplate"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}}},"put":{"summary":"Update a workflow template","description":"Updates an existing workflow template","operationId":"updateWorkflowTemplate","tags":["Workflow Templates"],"parameters":[{"name":"templateId","in":"path","required":true,"description":"The unique identifier of the workflow template","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowTemplateUpdate"}}}},"responses":{"200":{"description":"Workflow template updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowTemplate"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}}},"delete":{"summary":"Delete a workflow template","description":"Deletes a workflow template","operationId":"deleteWorkflowTemplate","tags":["Workflow Templates"],"parameters":[{"name":"templateId","in":"path","required":true,"description":"The unique identifier of the workflow template","schema":{"type":"string"}}],"responses":{"204":{"description":"Workflow template deleted successfully"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}}},"components":{"schemas":{"UserSummary":{"type":"object","required":["id","displayName","email"],"properties":{"id":{"type":"string","format":"uuid","description":"Internal unique identifier for the user.","readOnly":true,"example":"a1b2c3d4-e5f6-7890-1234-567890abcdef"},"displayName":{"type":"string","description":"User's display name.","example":"Alex Chen"},"email":{"type":"string","format":"email","description":"User's email address.","example":"alex.chen@example.com"}}},"UserCreate":{"type":"object","required":["displayName","email","orgRole"],"properties":{"displayName":{"type":"string","description":"User's display name.","example":"Alex Chen"},"email":{"type":"string","format":"email","description":"User's email address (must be unique).","example":"alex.chen@example.com"},"orgRole":{"type":"string","x-extensible-enum":["admin","member"],"description":"Role assigned to the user within the group.","example":"member"}}},"User":{"type":"object","required":["id","displayName","email","createdAt"],"properties":{"id":{"type":"string","format":"uuid","description":"Internal unique identifier for the user.","readOnly":true,"example":"a1b2c3d4-e5f6-7890-1234-567890abcdef"},"displayName":{"type":"string","description":"User's display name.","example":"Alex Chen"},"email":{"type":"string","format":"email","description":"User's email address.","example":"alex.chen@example.com"},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the user was created.","readOnly":true,"example":"2025-04-15T12:05:00Z"}}},"EntityReference":{"type":"object","required":["entityType","entityId"],"properties":{"entityType":{"type":"string","x-extensible-enum":["human","system"],"description":"The type of the entity being referenced.","example":"human"},"entityId":{"type":"string","format":"uuid","description":"The unique identifier (UUID) of the entity.","example":"a1b2c3d4-e5f6-7890-1234-567890abcdef"}}},"EntityMembershipAdd":{"type":"object","required":["entity","role"],"properties":{"entity":{"$ref":"#/components/schemas/EntityReference"},"role":{"type":"string","x-extensible-enum":["approver","admin","owner","auditor"],"description":"Role assigned to the entity within the group.","example":"approver"}}},"EntityMembershipRemove":{"type":"object","required":["entity"],"properties":{"entity":{"$ref":"#/components/schemas/EntityReference"}}},"AddGroupEntitiesRequest":{"type":"object","description":"Defines operations to add entities within a group","required":["entities"],"properties":{"entities":{"type":"array","items":{"$ref":"#/components/schemas/EntityMembershipAdd"},"description":"List of entities to add to the group."}}},"RemoveGroupEntitiesRequest":{"type":"object","description":"Defines operations to remove entities within a group","required":["entities"],"properties":{"entities":{"type":"array","items":{"$ref":"#/components/schemas/EntityMembershipRemove"},"description":"List of entities to remove from the group."}}},"GroupMembership":{"type":"object","required":["entity","role","addedAt"],"properties":{"entity":{"$ref":"#/components/schemas/EntityReference"},"role":{"type":"string","x-extensible-enum":["approver","admin","owner","auditor"],"description":"The role of the entity within the group.","example":"approver"},"addedAt":{"type":"string","format":"date-time","description":"Timestamp when the entity was added to the group.","readOnly":true,"example":"2025-04-16T10:30:00Z"}}},"WorkflowTemplateSummary":{"type":"object","required":["id","name","createdAt","updatedAt"],"properties":{"id":{"type":"string","format":"uuid","description":"Internal unique identifier for the workflow template.","readOnly":true,"example":"a1b2c3d4-e5f6-7890-1234-567890abcdef"},"name":{"type":"string","description":"User-friendly name for the workflow template.","example":"New Workflow Template"},"description":{"type":"string","description":"Detailed description of the workflow template.","example":"This is a new workflow template"},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the workflow template was created.","readOnly":true,"example":"2025-04-15T12:05:00Z"},"updatedAt":{"type":"string","format":"date-time","description":"Timestamp when the workflow template was last updated.","readOnly":true,"example":"2025-04-15T12:05:00Z"}}},"WorkflowCreate":{"type":"object","required":["name","workflowTemplateId"],"properties":{"name":{"type":"string","description":"User-friendly name for the workflow"},"description":{"type":"string","description":"Detailed description of the workflow"},"metadata":{"type":"object","description":"Additional custom metadata for the workflow"},"workflowTemplateId":{"type":"string","format":"uuid","description":"The unique identifier of the workflow template to use as parent"}}},"Workflow":{"type":"object","required":["id","name","status","workflowTemplateId","metadata","createdAt","updatedAt"],"properties":{"id":{"type":"string","description":"Unique identifier for the workflow"},"name":{"type":"string","description":"User-friendly name for the workflow"},"description":{"type":"string","description":"Detailed description of the workflow"},"status":{"type":"string","x-extensible-enum":["APPROVED","REJECTED","CANCELED","EVALUATION_IN_PROGRESS","EXPIRED"],"description":"Current status of the workflow"},"workflowTemplateId":{"type":"string","format":"uuid","description":"The unique identifier of the workflow template used as parent"},"metadata":{"type":"object","description":"Additional custom metadata for the workflow"},"ref":{"type":"object","description":"Referenced objects (optional, controlled by include query parameters)","properties":{"workflowTemplate":{"$ref":"#/components/schemas/WorkflowTemplate"}}},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp"},"updatedAt":{"type":"string","format":"date-time","description":"Last update timestamp"},"expiresAt":{"type":"string","format":"date-time","description":"Expiry timestamp","readOnly":true,"example":"2025-04-15T12:05:00Z"}}},"ApprovalRule":{"description":"Configuration of approval rules. Can be a boolean operator (AND/OR) combining nested rules, or a specific requirement (minimum count from a group).\n","oneOf":[{"$ref":"#/components/schemas/AndRule"},{"$ref":"#/components/schemas/OrRule"},{"$ref":"#/components/schemas/GroupRequirementRule"}],"discriminator":{"propertyName":"type","mapping":{"AND":"#/components/schemas/AndRule","OR":"#/components/schemas/OrRule","GROUP_REQUIREMENT":"#/components/schemas/GroupRequirementRule"}}},"AndRule":{"type":"object","description":"An AND rule requiring all nested rules to be satisfied.","required":["type","rules"],"properties":{"type":{"type":"string","enum":["AND"],"description":"Rule type (AND)"},"rules":{"type":"array","description":"List of rules that must all be satisfied. Cannot be empty.","minItems":1,"items":{"$ref":"#/components/schemas/ApprovalRule"}}}},"OrRule":{"type":"object","description":"An OR rule requiring at least one of the nested rules to be satisfied.","required":["type","rules"],"properties":{"type":{"type":"string","enum":["OR"],"description":"Rule type (OR)"},"rules":{"type":"array","description":"List of rules where at least one must be satisfied. Cannot be empty.","minItems":1,"items":{"$ref":"#/components/schemas/ApprovalRule"}}}},"GroupRequirementRule":{"type":"object","description":"Requires a minimum number of approvals from a specific group.","required":["type","groupId","minCount"],"properties":{"type":{"type":"string","enum":["GROUP_REQUIREMENT"],"description":"Rule type (GROUP_REQUIREMENT)"},"groupId":{"type":"string","description":"ID of the approver group."},"minCount":{"type":"integer","description":"Minimum number of approvals required from the group. Must be at least 1.","minimum":1}}},"GroupCreate":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Name of the group"},"description":{"type":"string","description":"Description of the group"}}},"Group":{"type":"object","required":["id","name","entitiesCount","createdAt","updatedAt"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the group"},"name":{"type":"string","description":"Name of the group"},"description":{"type":"string","description":"Description of the group"},"entitiesCount":{"type":"integer","description":"Number of entities in the group"},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp"},"updatedAt":{"type":"string","format":"date-time","description":"Last update timestamp"}}},"Pagination":{"type":"object","required":["total","page","limit"],"properties":{"total":{"type":"integer","description":"Total number of items"},"page":{"type":"integer","description":"Current page number"},"limit":{"type":"integer","description":"Items per page"}}},"APIError":{"type":"object","properties":{"code":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"message":{"type":"string"}}}}}},"WorkflowVoteRequest":{"type":"object","title":"WorkflowVoteRequest","required":["voteType"],"properties":{"reason":{"type":"string","description":"Optional reason for the vote. Can be used for approval comments or reject reasons.","example":"Missing critical information or LGTM!"},"voteType":{"oneOf":[{"$ref":"#/components/schemas/VoteApprove"},{"$ref":"#/components/schemas/VoteVeto"},{"$ref":"#/components/schemas/VoteWithdraw"}],"discriminator":{"propertyName":"type","mapping":{"APPROVE":"#/components/schemas/VoteApprove","VETO":"#/components/schemas/VoteVeto","WITHDRAW":"#/components/schemas/VoteWithdraw"}}}}},"CanVoteResponse":{"type":"object","title":"CanVoteResponse","required":["canVote","voteStatus"],"properties":{"canVote":{"type":"boolean","description":"True if the authenticated entity can currently vote on the workflow, false otherwise."},"voteStatus":{"type":"string","x-extensible-enum":["ALREADY_VOTED","VOTE_PENDING"],"description":"Indicates the voting status for the user on this workflow.\n","example":"VOTE_PENDING"},"cantVoteReason":{"type":"string","description":"Reason why the entity cannot vote on the workflow. The value is only set if 'canVote' is false.","x-extensible-enum":["WORKFLOW_EXPIRED","WORKFLOW_APPROVED","WORKFLOW_CANCELED","NOT_ELIGIBLE_TO_VOTE"]}}},"VoteApprove":{"type":"object","required":["type","votedForGroups"],"properties":{"type":{"type":"string","enum":["APPROVE"],"description":"Vote type (APPROVE)"},"votedForGroups":{"type":"array","items":{"type":"string","format":"uuid"},"description":"List of group IDs the vote is cast for.","example":["a1b2c3d4-e5f6-7890-1234-567890abcdef"]}}},"VoteVeto":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["VETO"],"description":"Vote type (VETO)"}}},"VoteWithdraw":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["WITHDRAW"],"description":"Vote type (WITHDRAW)"}}},"WorkflowTemplateCreate":{"type":"object","required":["name","approvalRule"],"properties":{"name":{"type":"string","description":"User-friendly name for the workflow template"},"description":{"type":"string","description":"Detailed description of the workflow template"},"metadata":{"type":"object","description":"Additional custom metadata for the workflow template"},"approvalRule":{"$ref":"#/components/schemas/ApprovalRule"},"actions":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowAction"},"description":"Actions to be executed when workflow is approved"},"defaultExpiresInHours":{"type":"integer","minimum":1,"maximum":8760,"description":"Default expiry time for workflows created from this template (in hours, max 1 year)"}}},"WorkflowTemplate":{"type":"object","required":["id","name","approvalRule","createdAt","updatedAt"],"properties":{"id":{"type":"string","description":"Unique identifier for the workflow template"},"name":{"type":"string","description":"User-friendly name for the workflow template"},"description":{"type":"string","description":"Detailed description of the workflow template"},"approvalRule":{"$ref":"#/components/schemas/ApprovalRule"},"metadata":{"type":"object","description":"Additional custom metadata for the workflow template"},"actions":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowAction"},"description":"Actions to be executed when workflow is approved"},"defaultExpiresInHours":{"type":"integer","minimum":1,"maximum":8760,"description":"Default expiry time for workflows created from this template (in hours, max 1 year)"},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp"},"updatedAt":{"type":"string","format":"date-time","description":"Last update timestamp"}}},"WorkflowTemplateUpdate":{"type":"object","properties":{"name":{"type":"string","description":"User-friendly name for the workflow template"},"description":{"type":"string","description":"Detailed description of the workflow template"},"metadata":{"type":"object","description":"Additional custom metadata for the workflow template"},"approvalRule":{"$ref":"#/components/schemas/ApprovalRule"},"actions":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowAction"},"description":"Actions to be executed when workflow is approved"},"defaultExpiresInHours":{"type":"integer","minimum":1,"maximum":8760,"description":"Default expiry time for workflows created from this template (in hours, max 1 year)"}}},"WorkflowAction":{"description":"Configuration for actions to be executed when workflow is approved. Currently supports email actions.\n","oneOf":[{"$ref":"#/components/schemas/EmailAction"}],"discriminator":{"propertyName":"type","mapping":{"EMAIL":"#/components/schemas/EmailAction"}}},"EmailAction":{"type":"object","description":"Sends an email when workflow is approved","required":["type","recipients"],"properties":{"type":{"type":"string","enum":["EMAIL"],"description":"Action type (EMAIL)"},"recipients":{"type":"array","items":{"type":"string","format":"email"},"description":"List of email addresses to send the notification to","minItems":1,"maxItems":5}}}},"responses":{"BadRequest":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}},"Unauthorized":{"description":"Authentication required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}},"NotFound":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}}},"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}}},"security":[{"bearerAuth":[]}]}},"searchIndex":{"store":["tag/Workflows","tag/Workflows/operation/createWorkflow","tag/Workflows/operation/listWorkflows","tag/Workflows/operation/getWorkflow","tag/Workflow-Templates","tag/Workflow-Templates/operation/createWorkflowTemplate","tag/Workflow-Templates/operation/listWorkflowTemplates","tag/Workflow-Templates/operation/getWorkflowTemplate","tag/Workflow-Templates/operation/updateWorkflowTemplate","tag/Workflow-Templates/operation/deleteWorkflowTemplate","tag/Users","tag/Users/operation/createUser","tag/Users/operation/listUsers","tag/Users/operation/getUser","tag/Users/operation/listGroupEntities","tag/Users/operation/addGroupEntities","tag/Users/operation/removeGroupEntities","tag/Groups","tag/Groups/operation/createGroup","tag/Groups/operation/listGroups","tag/Groups/operation/getGroup","tag/Groups/operation/listGroupEntities","tag/Groups/operation/addGroupEntities","tag/Groups/operation/removeGroupEntities","tag/Workflow-Actions","tag/Workflow-Actions/operation/voteOnWorkflow","tag/Workflow-Actions/operation/canVoteOnWorkflow"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,0.074]],["description/0",[0,0.069,1,2.298,2,1.836]],["title/1",[0,0.052,3,1.12,4,1.12]],["description/1",[0,0.076,2,1.46,3,1.192,4,1.192,5,2.416]],["title/2",[0,0.061,6,0.89]],["description/2",[0,0.076,6,0.806,7,0.981,8,2.416,9,2.416]],["title/3",[0,0.061,10,1.315]],["description/3",[0,0.059,7,1.053,10,1.279,11,0.955,12,3.141]],["title/4",[0,0.061,13,0.89]],["description/4",[0,0.069,1,2.298,13,1.014]],["title/5",[0,0.045,3,0.976,4,0.976,13,0.66]],["description/5",[0,0.041,2,1.089,3,0.889,4,0.889,5,1.802,13,0.601,14,1.551,15,2.183,16,2.183,17,2.183,18,1.802]],["title/6",[0,0.052,6,0.758,13,0.758]],["description/6",[0,0.052,6,0.755,7,0.918,8,2.262,9,2.262,13,0.755,18,2.262]],["title/7",[0,0.052,10,1.12,13,0.758]],["description/7",[0,0.055,7,0.981,10,1.192,11,0.89,13,0.806,19,2.079]],["title/8",[0,0.052,13,0.758,20,2.27]],["description/8",[0,0.059,13,0.865,19,2.232,20,2.593,21,3.141]],["title/9",[0,0.052,13,0.758,22,2.27]],["description/9",[0,0.064,13,0.934,19,2.408,22,2.797]],["title/10",[23,0.879]],["description/10",[1,2.514,23,0.905]],["title/11",[3,1.12,4,1.12,23,0.618]],["description/11",[3,1.279,4,1.279,23,0.949,24,2.232]],["title/12",[6,0.89,23,0.726]],["description/12",[6,0.934,7,1.136,23,0.998]],["title/13",[10,1.315,23,0.726]],["description/13",[7,0.981,10,1.192,11,0.89,23,0.658,25,2.927,26,2.927]],["title/14",[6,0.758,27,0.556,28,0.293]],["description/14",[6,0.572,7,0.696,11,0.632,23,0.467,24,1.476,27,0.42,28,0.221,29,1.715,30,1.715,31,1.715,32,1.715,33,1.036]],["title/15",[27,0.556,28,0.293,34,1.718]],["description/15",[11,0.833,23,0.616,27,0.554,28,0.292,33,1.367,34,1.711,35,2.262]],["title/16",[27,0.556,28,0.293,36,1.718]],["description/16",[11,0.89,23,0.658,27,0.591,28,0.312,33,1.46,36,1.828]],["title/17",[28,0.416]],["description/17",[1,2.514,28,0.429]],["title/18",[2,1.195,3,0.976,4,0.976,28,0.255]],["description/18",[2,1.46,3,1.192,4,1.192,28,0.429,37,2.927]],["title/19",[6,0.89,28,0.344]],["description/19",[6,0.934,7,1.136,28,0.473]],["title/20",[10,1.315,28,0.344]],["description/20",[7,1.053,10,1.279,11,0.955,28,0.335,38,3.141]],["title/21",[6,0.758,27,0.556,28,0.293]],["description/21",[6,0.572,7,0.696,11,0.632,23,0.467,24,1.476,27,0.42,28,0.221,29,1.715,30,1.715,31,1.715,32,1.715,33,1.036]],["title/22",[27,0.556,28,0.293,34,1.718]],["description/22",[11,0.833,23,0.616,27,0.554,28,0.292,33,1.367,34,1.711,35,2.262]],["title/23",[27,0.556,28,0.293,36,1.718]],["description/23",[11,0.89,23,0.658,27,0.591,28,0.312,33,1.46,36,1.828]],["title/24",[0,0.061,14,2.294]],["description/24",[0,0.069,14,2.614,39,2.046]],["title/25",[0,0.061,39,1.795]],["description/25",[0,0.043,2,1.147,11,0.699,27,0.465,39,1.279,40,2.3,41,1.898,42,1.898,43,2.3,44,2.3]],["title/26",[0,0.04,27,0.429,39,1.179,45,2.121,46,2.121]],["description/26",[0,0.046,27,0.491,39,1.351,41,2.006,42,2.006,47,2.43,48,2.43,49,2.43,50,2.43]]],"invertedIndex":[["action",{"_index":14,"title":{"24":{}},"description":{"5":{},"24":{}}}],["add",{"_index":34,"title":{"15":{},"22":{}},"description":{"15":{},"22":{}}}],["allow",{"_index":40,"title":{},"description":{"25":{}}}],["approv",{"_index":2,"title":{"18":{}},"description":{"0":{},"1":{},"5":{},"18":{},"25":{}}}],["authent",{"_index":41,"title":{},"description":{"25":{},"26":{}}}],["belong",{"_index":30,"title":{},"description":{"14":{},"21":{}}}],["cast",{"_index":42,"title":{},"description":{"25":{},"26":{}}}],["check",{"_index":45,"title":{"26":{}},"description":{}}],["creat",{"_index":3,"title":{"1":{},"5":{},"11":{},"18":{}},"description":{"1":{},"5":{},"11":{},"18":{}}}],["current",{"_index":46,"title":{"26":{}},"description":{}}],["default",{"_index":15,"title":{},"description":{"5":{}}}],["delet",{"_index":22,"title":{"9":{}},"description":{"9":{}}}],["detail",{"_index":10,"title":{"3":{},"7":{},"13":{},"20":{}},"description":{"3":{},"7":{},"13":{},"20":{}}}],["determin",{"_index":47,"title":{},"description":{"26":{}}}],["elig",{"_index":48,"title":{},"description":{"26":{}}}],["entiti",{"_index":27,"title":{"14":{},"15":{},"16":{},"21":{},"22":{},"23":{},"26":{}},"description":{"14":{},"15":{},"16":{},"21":{},"22":{},"23":{},"25":{},"26":{}}}],["etc",{"_index":29,"title":{},"description":{"14":{},"21":{}}}],["exist",{"_index":21,"title":{},"description":{"8":{}}}],["expiri",{"_index":16,"title":{},"description":{"5":{}}}],["filter",{"_index":9,"title":{},"description":{"2":{},"6":{}}}],["group",{"_index":28,"title":{"14":{},"15":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{},"22":{},"23":{}},"description":{"14":{},"15":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{},"22":{},"23":{}}}],["groups/{groupidentifi",{"_index":38,"title":{},"description":{"20":{}}}],["groups/{groupid}/ent",{"_index":33,"title":{},"description":{"14":{},"15":{},"16":{},"21":{},"22":{},"23":{}}}],["id",{"_index":25,"title":{},"description":{"13":{}}}],["includ",{"_index":31,"title":{},"description":{"14":{},"21":{}}}],["list",{"_index":6,"title":{"2":{},"6":{},"12":{},"14":{},"19":{},"21":{}},"description":{"2":{},"6":{},"12":{},"14":{},"19":{},"21":{}}}],["manag",{"_index":1,"title":{},"description":{"0":{},"4":{},"10":{},"17":{}}}],["new",{"_index":4,"title":{"1":{},"5":{},"11":{},"18":{}},"description":{"1":{},"5":{},"11":{},"18":{}}}],["option",{"_index":8,"title":{},"description":{"2":{},"6":{}}}],["organ",{"_index":37,"title":{},"description":{"18":{}}}],["remov",{"_index":36,"title":{"16":{},"23":{}},"description":{"16":{},"23":{}}}],["return",{"_index":7,"title":{},"description":{"2":{},"3":{},"6":{},"7":{},"12":{},"13":{},"14":{},"19":{},"20":{},"21":{}}}],["role",{"_index":32,"title":{},"description":{"14":{},"21":{}}}],["rule",{"_index":5,"title":{},"description":{"1":{},"5":{}}}],["set",{"_index":17,"title":{},"description":{"5":{}}}],["specif",{"_index":11,"title":{},"description":{"3":{},"7":{},"13":{},"14":{},"15":{},"16":{},"20":{},"21":{},"22":{},"23":{},"25":{}}}],["specifi",{"_index":49,"title":{},"description":{"26":{}}}],["system",{"_index":24,"title":{},"description":{"11":{},"14":{},"21":{}}}],["templat",{"_index":13,"title":{"4":{},"5":{},"6":{},"7":{},"8":{},"9":{}},"description":{"4":{},"5":{},"6":{},"7":{},"8":{},"9":{}}}],["updat",{"_index":20,"title":{"8":{}},"description":{"8":{}}}],["user",{"_index":23,"title":{"10":{},"11":{},"12":{},"13":{}},"description":{"10":{},"11":{},"12":{},"13":{},"14":{},"15":{},"16":{},"21":{},"22":{},"23":{}}}],["users/{userid",{"_index":26,"title":{},"description":{"13":{}}}],["veto",{"_index":43,"title":{},"description":{"25":{}}}],["vote",{"_index":39,"title":{"25":{},"26":{}},"description":{"24":{},"25":{},"26":{}}}],["within",{"_index":35,"title":{},"description":{"15":{},"22":{}}}],["workflow",{"_index":0,"title":{"0":{},"1":{},"2":{},"3":{},"4":{},"5":{},"6":{},"7":{},"8":{},"9":{},"24":{},"25":{},"26":{}},"description":{"0":{},"1":{},"2":{},"3":{},"4":{},"5":{},"6":{},"7":{},"8":{},"9":{},"24":{},"25":{},"26":{}}}],["workflow-templ",{"_index":18,"title":{},"description":{"5":{},"6":{}}}],["workflow-templates/{templateid",{"_index":19,"title":{},"description":{"7":{},"8":{},"9":{}}}],["workflows/{workflowid",{"_index":12,"title":{},"description":{"3":{}}}],["workflows/{workflowid}/canvot",{"_index":50,"title":{},"description":{"26":{}}}],["workflows/{workflowid}/vot",{"_index":44,"title":{},"description":{"25":{}}}]],"pipeline":[]}},"options":{}};
|
|
735
|
+
|
|
736
|
+
var container = document.getElementById('redoc');
|
|
737
|
+
Redoc.hydrate(__redoc_state, container);
|
|
738
|
+
|
|
739
|
+
</script>
|
|
740
|
+
</body>
|
|
741
|
+
|
|
742
|
+
</html>
|